QR/Wallet PIX

Hacer un retiro en Brasil por medio de PIX consiste en capturar los datos necesarios de la persona que recibirá el pago y hacer una solicitud a través de nuestra API con un bearer token y una firma secreta. De esta forma, las transacciones se autentican y se realizan de forma segura.

Crea un nuevo retiro

Para hacer una solicitud de nuevo retiro a través de nuestra API deberás usar este endpoint. La solicitud se envía con tu bearer token, así como con tu firma secreta.

🚧

Firma de la transacción

Puedes ver el detalle de cómo firmar los parámetros de la transacción con tu secretKey en este artículo.

Además, debes incluir los datos necesarios del cliente al que le mandarás el dinero, como: nombre, apellido, correo electrónico, teléfono, ID, cuenta, entre otros.

📘

Notificación del estado de la transacción

Para configurar el webhook que irá en el campo confirmationURL y recibir notificaciones con el estado de tu transacción, revisa este artículo.

Body de la solicitud

A continuación puedes ver un ejemplo del body que se envía en la solicitud:

{
  "amount": 100,
  "document_id": "12345678912",
  "beneficiaryName": "John",
  "beneficiaryLastName": "Doe",
  "beneficiaryEmail": "[email protected]",
  "beneficiaryPhone": "999999999",
  "accountType": "1",
  "bankCode": "633",
  "data": "1234",
  "confirmationURL": "Webhook",
  "currency": "BRL",
  "country": "BR",
  "sign": "Signature of the parameters",
  "pagamentoType": 1,
  "type": "beneficiaryPhone",
  "accountNumber": "11111111",
  "agency": "string",
  "ispb": "string"
}

Respuesta

Como respuesta a una solicitud de pago exitosa, recibirás un identificador del retiro en el sistema, el estado del retiro y datos adicionales de la transacción.

Confirmación de un retiro

Una vez que hayas completado el proceso, ProntoPaga devolverá los datos de la transacción a la URL que especificaste en confirmationURL.

Para confirmar si una transacción fue exitosa, debes verificar que en tu webhook el valor del campo status sea success.

Conoce todos los estados posibles de un retiro en el siguiente enlace: Estados de los pay outs.

Prueba tu integración

Contamos con un catálogo de datos de prueba que puedes usar para comprobar que tu integración está lista, así como para ver el flujo de pago que seguirá tu cliente. Además, también puedes hacer pruebas con nuestros demos.