get
https://api.somossimpay.com.br/v2/finance/status-cashout/tag?tag=
Params (Query Params)
| Parameter | Value | Description | Example |
|---|---|---|---|
| tag | Number | Fill in the tag ID, a custom identifier generated by the client. This is a custom field that the client can use to input values or their own identifiers for internal control. | EX: w000196980001 |
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Response Details
{
"worked": true,
"id": 66300134,
"transaction_id": 66300134,
"code_transaction": "E35535240202******BROEA793YQI",
"status": "SUCCESS",
"amount": 0.01,
"fee": 0.0,
"key": "14******47",
"tag": null,
"from_accout": "900002",
"recipient_instution": "0000001",
"recipient_account_id": "000001",
"recipient_branch_id": "20",
"recipient_legal_id": "14******47",
"recipient_name": "Fulano de tal",
"recipient_account_type": "CURRENT_ACCOUNT",
"operationUuid": "E35535240202******BROEA793YQI",
"erro_descriptor": "",
"new_erro_descriptor": ""
}
| Field | Description |
|---|---|
| worked | Returns true or false confirming whether the PIX Transfer (Cash Out) was successful or not |
| id | Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status |
| transaction_id | Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status and details |
| code_transaction | Returns the Unique payment identifier generated (UUID). This value never repeats; it's a universal tracking value for the payment among the involved banking institutions. |
| status | NEW - 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 |
| amount | Returns the transfer amount. (the same information that was sent in the body) |
| fee | This field returns the fee charged to when using the PIX Transfer (Cash Out) endpoint |
| key | Returns the Pix key (the same information that was sent in the request body) |
| from_accout | Returns the account number of the originating account that performed the transfer. |
| Tag | This field returns the Tag (Optional custom code). Same information that was sent in the body |
| recipient_name | Returns the full name of the recipient, either an individual (PF) or a company (PJ) |
| recipient_instution | Returns the ISPB code associated with the destination bank. |
| recipient_branch_identifier | Returns the bank branch of the recipient (Agency). |
| recipient_account_id | Returns the account number of the recipient. |
| recipient_legal_id | Returns the document number of the recipient, either an individual (PF) or a company (PJ). |
| operationUuid | Returns the operationUuid, also known as the “EndtoEnd” value. This value never repeats, and it enables querying endpoints to confirm the payment status |
| erro_descriptor | Returns an error message, if applicable |
| new_erro_descriptor | Returns an error message, if applicable |