Criar uma nova retirada
POST - https://url.base/api/withdrawal/pix/new
Endpoint para criar uma nova retirada. Para criar uma nova solicitação de retirada, a solicitação deve ser construída com os seguintes parâmetros.
(*) Informações necessárias.
| Campo | Tipo | Descrição |
|---|---|---|
| *amount | Integer | Valor da transação |
| *document_id | String | Documento de identidade do beneficiário |
| *beneficiaryName | String | Nome completo do beneficiário |
| *beneficiaryLastName | String | Sobrenome do beneficiário |
| *beneficiaryEmail | String | Email do beneficiário |
| *beneficiaryPhone | String | Número de telefone do beneficiário |
| *accountNumber | String | Número da conta bancária |
| *accountType | String | Tipo de conta bancária |
| *bankCode | String | Código do banco |
| *data | String | Identificador da retirada a ser associada. O campo "data" deve ser único e não repetitivo |
| *confirmationURL | Link | URL para confirmação da transação |
| *currency | String | Código ISO da moeda # Países e moedas |
| *country | String | Formato internacional do país # Países e moedas |
| *sign | String | A assinatura dos parâmetros é única para cada transação |
| *pagamentoType | Integer | Este é o campo diferenciador ao solicitar uma retirada PIX. O valor (1) indica retirada com uma conta bancária, o valor (2) indica retirada com uma chave PIX |
| *Type | String | Este campo diferencia que tipo de PIX será usado ao gerar a retirada e deve ser distinguido por: 'document_id (CPF)' ou 'beneficiaryEmail' ou 'beneficiaryPhone' |
| accountNumber | String | Bank account number (Only payment type 1) |
| agency | String | Agência bancária brasileira onde a retirada será feita para pagamento tipo 2, retirada com conta bancária (Apenas tipo de pagamento 1) |
| ispb | String | o ispbParticipante da instituição financeira associada ao contato (Apenas tipo de pagamento 1) |
info
Após o usuário concluir o processo de retirada, a ProntoPaga retornará os dados para a URL que você especificou em urlConfirmation
Response OK
{
"uid" = [string] // Identificador da retirada no sistema,
"status" = [string] // Status da retirada,
"data" = [string] // Dados adicionais da transação
}
Status response
| Campo | Descrição |
|---|---|
| 200 - 201: OK | Retirada criada com sucesso |
| 401: Unauthorized | Permissão negada |