post
https://api.somossimpay.com.br/v2/finance/create-cashout/
Transfer funds from the business bank account to other accounts using PIX technology without approval
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
| hmac | String | HMAC (Hash-based Message Authentication Code) | 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6) |
Body Details
{
"source_account_branch_identifier": "0001",
"source_account_number": "0001",
"amount": 0.01,
"key": "144******44",
"tag": "description"
}
| Field | Description | Required or Optional |
|---|---|---|
| source_account_branch_identifier | source_account_branch_identifier: In this field, you should provide the number of the originating bank branch from which the money will be withdrawn. The branch number always consists of 4 digits (e.g., 0001). | required |
| source_account_number | In this field, you should provide the bank account number from which the money will be withdrawn. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered typically have 6 characters). | required |
| amount | In this field, you should provide the desired amount for the transfer. | required |
| key | The PIX, Brazilian instant payment system, allows the generation of different types of keys for recipient identification. Here are the types of PIX keys with their respective character lengths: Random (EVP Method): This key is randomly generated by the system and can contain up to 36 alphanumeric characters. It's a convenient option for those who don't wish to expose personal information, such as CPF or phone number. Ex: dcce9074-132f-4bf9-a873-232851c818c48 CPF/CNPJ: This key uses the CPF (Individual Taxpayer Registry) or CNPJ (National Registry of Legal Entities) number and has 11 or 14 digits, respectively. It's an option for those who want to use the document number as identification. Ex: CPF: 45831389030 CNPJ: 54977478000103 Email: This key uses the user's email address and can contain up to 180 characters, following the standard email address format. Ex: [email protected] Phone: This key uses the user's cellphone number and has 13 digits (including country code, area code, and number). Ex: +5511990028754 | required |
| Tag | This is an optional field where you can input a custom code that will be associated with the pix cashout to facilitate tracking, management, and payment control. | Optional |
Response Details
{
"worked": true,
"id": 78200134,
"transaction_id": 78200134,
"code_transaction": null,
"status": "PROCESSING",
"amount": 0.01,
"fee": 0.0,
"key": "144******47",
"tag": null,
"from_accout": "900002",
"recipient_instution": null,
"recipient_instution_name": null,
"recipient_account_id": null,
"recipient_branch_id": null,
"recipient_legal_id": null,
"recipient_name": null,
"recipient_account_type": null,
"operationUuid": null,
"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 |