PRprontopaga

Crear un nuevo retiro - Brasil Pix

post/withdrawal/pix/new

Request

Request body

amountinteger required

Monto de la transacción

document_idstring required

Documento de identidad del beneficiario

beneficiaryNamestring required

Primer nombre del beneficiario

beneficiaryLastNamestring required

Apellido del beneficiario

beneficiaryEmailstring required

Correo electrónico del beneficiario

beneficiaryPhonestring required

Número de teléfono del beneficiario.

accountTypestring required

Tipo de cuenta bancaria. <br> Puede ser: <b>C, SL, S, P<b>.

bankCodestring 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.

datastring required

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

confirmationURLstring required

Webhook. Conoce más información en <a href="https://docs.prontopaga.com/docs/webhooks">este artículo</a>.

currencystring required

Código ISO de la moneda: <b>BRL.

countrystring required

Código del país: <b>BR</b>.

signstring required

La firma de los parámetros es única para cada transacción. Conoce cómo firmar en <a href="https://docs.prontopaga.com/docs/sign-transactions">este artículo</a>.

pagamentoTypeinteger required

Este es el campo diferenciador al solicitar un retiro PIX. <br> <ul> <li>El valor C corresponde a un retiro con una cuenta corriente.</li> <li>El valor SL corresponde a un retiro con una cuenta sueldo.</li><li>El valor S corresponde a un retiro con una cuenta de ahorros.</li> <li>El valor P es un retiro con una cuenta de pagos.</li> </ul>

typestring 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.

accountNumberstring required

Número de cuenta bancaria.

agencystring

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

ispbstring

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

Response

200

Changes

No recorded changes to this operation across all 2 revisions of this API.