Payment Pooling

The Status API contains the endpoints to get more details of a payment and also a quick status check.

Fields with * are required. The others are considered optional.

Check Status

To check the status of payments (deposits) you can use the endpoints below

Check transaction status

HEAD https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference/check

Check transaction status with HTTP status-only

Path Parameters

Name	Type	Description
external_reference*	String	Pagstar transaction reference

Headers

Name	Type	Description
Authorization*	String	Bearer token
Content-Type*	String	Empresa X ([e-mail])
User-Agent*	String	application/json

200: OK Paid transaction

400: Bad Request Error

404: Not Found Not Exist

402: Payment Required Waiting for payment

401: Unauthorized Unauthorized

Get Transaction status

GET https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference

Returns transaction info

Path Parameters

Name	Type	Description
external_reference*	String	Pagstar transaction reference

Headers

Name	Type	Description
Authorization*	String	Bearer token
Content-Type*	String	Empresa X ([e-mail])
User-Agent*	String	application/json

200: OK Success

{
    "message": "Success.",
    "data": {
        "id": 168258,
        "external_reference": "47023acc-0727-476a-a011-9d759e7f58c9",
        "value": 10,
        "callback": null,
        "type": "payment",
        "user_id": 347,
        "status": 1,
        "deeplink": null,
        "pix_deposit": {
            "qr_code_url": "https://chart.googleapis.com/chart?chs=150x150&cht=qr&chl=IxoYKcQw.PAGSTARMOCK2022.Je2KjEG3XgdW.yogJySWhNLjVsdilBn4hqUd9",
            "pix_key": "IxoYKcQw.PAGSTARMOCK2022.Je2KjEG3XgdW.yogJySWhNLjVsdilBn4hqUd9",
            "favoured": "Pagstar Servicos de Pagamento",
            "external_reference": "47023acc-0727-476a-a011-9d759e7f58c9",
            "checkout": "https://dev-checkout.pagstar.com/payment/pix/47023acc-0727-476a-a011-9d759e7f58c9"
        },
        "partner": {
            "name": "Futurama",
            "document": "87539319"
        },
        "tenant": {
            "id": "992bbc18-0b59-4e5f-9bb5-4fca4b3b749a",
            "name": "EGS"
        },
        "created_at": "2022-08-26T00:28:09.000000Z"
    }
}

404: Not Found Not Found

{
    "message": "Não foi possível encontrar esta transação",
    "data": []
}

401: Unauthorized Unauthorized