Create a new withdrawal
POST - https://url.base/api/withdrawal/pix/new
Endpoint to create a new withdrawal. To create a new withdrawal request, the request must be built with the following parameters.
(*) Required Information.
| Field | Type | Description |
|---|---|---|
| *amount | Integer | Transaction amount |
| *document_id | String | Beneficiary's identeficiarity document |
| *beneficiaryName | String | Beny's full namicie |
| *beneficiaryLastName | String | Benefary's last name |
| *beneficiaryEmail | String | Beneficiary's Email |
| *beneficiaryPhone | String | Beneficiary's phone number |
| *accountType | String | Bank account type |
| *bankCode | String | Bank code |
| *data | String | Identifier of the Withdrawal to associate. The "data" field must be unique and non-repetitive. |
| *confirmationURL | Link | URL for transaction confirmation |
| *currency | String | ISO currency code. # Countries and currencies​ |
| *country | String | International country format # Countries and currencies​​ |
| *sign | String | The signature of the parameters is unique for each transaction |
| *pagamentoType | Integer | This is the differentiating field when requesting a PIX withdrawal. Value (1) is withdrawal with a bank account, Value (2) is withdrawal with a PIX key |
| *Type | String | This field differentiates what type of PIX will be used when generating the withdrawal, and it should be distinguished by: 'document_id (CPF)' or 'beneficiaryEmail' or 'beneficiaryPhone' |
| accountNumber | String | Bank account number (Only payment type 1) |
| agency | String | Brazilian bank branch where the withdrawal will be made for pagamentoType 2, bank account withdrawal (Only payment type 1) |
| ispb | String | the ispbParticipant of the financial institution associated with the contact (Only payment type 1) |
info
Once the user has completed the withdrawal process, ProntoPaga will return the data to the URL you specified in the urlConfirmation
Response OK​
{
"uid" : [string] // Withdrawal identifier in the system,
"status" : [string] // withdrawal status,
"data" : [string] // Additional transaction data
}
Status response​
| Field | Description |
|---|---|
| 200 - 201: OK | Withdrawal created successfully |
| 401: Unauthorized | Permission denied |