Check Status of a PIX Cash Out by EndtoEnd

Params (Query Params)

ParameterValueDescriptionExample
e2e_idNumberFill in the EndToEnd ID, the unique identifier generatedEX: E10573521202506191321lDAGfhbA9f6

Headers

ParameterTypeDescriptionExample
AuthorizationStringBearer + Access_tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

{
    "worked": true,
    "id": 175***,
    "transaction_id": 175***,
    "code_transaction": "E35535*******************X1DV",
    "status": "SU****",
    "amount": 0.01,
    "fee": 0.0,
    "key": "lr4*********@gmail.com",
    "tag": "hsy**********",
    "from_accout": "900***",
    "recipient_instution": "105****",
    "recipient_account_id": "656********",
    "recipient_branch_id": "*",
    "recipient_legal_id": "348********",
    "recipient_name": "Lu***********ha",
    "recipient_account_type": null,
    "operationUuid": "E35535*******************X1DV",
    "erro_descriptor": "",
    "new_erro_descriptor": ""
}

FieldDescription
workedReturns true or false confirming whether the query was successfully returned or not
transaction_idUnique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status
code_transactionReturns the Unique payment identifier generated (UUID). This value never repeats; it's a universal tracking value for the payment among the involved banking institutions.
statusNEW - Payment generated, awaiting payment by the customer PROCESSING - Indicates that the payment is in processing.
SUCCESS - Payment successfully completed
CANCELED - Payments not approved, expired or cancelled.
amountReturns the transfer amount. (the same information that was sent in the body)
feeThis field returns the fee charged to the SaQ.Digital customer when using the PIX Transfer (Cash Out) endpoint
keyReturns the Pix key (the same information that was sent in the request body)
from_accoutReturns the account number of the originating account that performed the transfer.
TagReturns the optional tag field where you can input a custom code if applicable
recipient_nameReturns the full name of the recipient, either an individual (PF) or a company (PJ)
recipient_instutionReturns the ISPB code associated with the destination bank.
recipient_branch_identifierReturns the bank branch of the recipient (Agency).
recipient_account_idReturns the account number of the recipient.
recipient_legal_idReturns the document number of the recipient, either an individual (PF) or a company (PJ).
operationUuidReturns the operationUuid, also known as the “EndtoEnd” value. This value never repeats, and it enables querying endpoints to confirm the payment status
erro_descriptorReturns an error message, if applicable
new_erro_descriptorReturns an error message, if applicable
Language
Click Try It! to start a request and see the response here!