API Reference
FAQs

Crear un nuevo retiro - Brasil Pix

post
https://sandbox.prontopaga.com/api/withdrawal/pix/new
Body Params
int32
required

Monto de la transacción

string
required

Documento de identidad del beneficiario

string
required

Primer nombre del beneficiario

string
required

Apellido del beneficiario

string
required

Correo electrónico del beneficiario

string
required

Número de teléfono del beneficiario.

string
required

Tipo de cuenta bancaria.
Puede ser: C, SL, S, P.

string
required

Código bancario. Descarga el listado completo de códigos bancarios para retiros en Brasil.

Al crear una solicitud de PayOut, el valor que envíes en el campo bankCode debe corresponder al valor code de la lista de códigos.

string
required

Identificador del Retiro a asociar. Debe ser único e irrepetible

string
required

Webhook. Conoce más información en este artículo.

string
required

Código ISO de la moneda: BRL.

string
required

Código del país: BR.

string
required

La firma de los parámetros es única para cada transacción. Conoce cómo firmar en este artículo.

int32
required

Este es el campo diferenciador al solicitar un retiro PIX.

  • El valor C corresponde a un retiro con una cuenta corriente.
  • El valor SL corresponde a un retiro con una cuenta sueldo.
  • El valor S corresponde a un retiro con una cuenta de ahorros.
  • El valor P es un retiro con una cuenta de pagos.

string
required

Este campo diferencia qué tipo de Pix se utilizará al generar el retiro y se debe distinguir por: document_id (CPF), beneficiaryEmail o beneficiaryPhone.

string
required

Número de cuenta bancaria.

string

Sucursal bancaria brasileña donde se realizará el retiro para el tipo de pago SL, retiro a cuenta bancaria.

string

La ispb participante de la institución financiera asociada al contacto.

Responses

Updated 3 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago