Transfer Pooling

The Status API contains the endpoints to get more details of a transfer 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

Get Transaction status

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

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 Processing

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "processing",
        "status_description": null,
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": null
    }
}

404: Not Found Not Found

{
    "message": "Transferência não encontrada",
    "data": []
}

401: Unauthorized Unauthorized

200: OK Canceled

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "canceled",
        "status_description": "Liquidação da transação interrompida devido a timeout no SPI.",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": ""
    }
}

200: OK Approved

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": true,
        "status": "approved",
        "status_description": "Success",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": "E0825353920230521050444SXCR"
    }
}