PicPay Payout

Introduction

PicPay is a digital wallet that offers a user-friendly way to make transactions, pay bills, and transfer money right from your phone. It operates everyday, offering a secure platform for sending money, making payments, receiving funds, businesses, and for services.

Generate PayOuts

To generate a PicPay PayOut, you need to send a POST request to the following endpoint:

POST /api/v1/payouts
Host: binance.latamgateway.com
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

{
  "partner_code": "0001",
  "name": "Customer’s full name",
  "document": "111.222.333-44",
  "email": "[email protected]",
  "phone": "11999999999",
  "birth": "1996-03-09",
  "value": 10.23,
  "fee_payer": "merchant",
  "payment_method": "picpay",
  "notification_url": "your_payback_notification_url.com"
}

Params descriptions

Field	Description	Value Type	Requirement
partner_code	Payout reference in your system	String	Required
name	Customer's full name	String	Required
document	Customer's document (CPF)	String	Required
email	Customer's email address	String	Required
phone	Customer's phone number	String	Required
birth	Customer's date of birth	String	Required
value	Total transaction value	Number (Decimal)	Required
fee_payer	Fee payer: "merchant" (default) or "customer"	String	Required
payment_method	Payment method (e.g., picpay)	String	Required
notification_url	URL to notify when status changes	String	Required

The document can be a valid CPF. PicPay payOuts are available exclusively for individuals and cannot be made to businesses.

If the provided document is not linked to a PicPay account, the payout will be created but not processed. You will receive a webhook notification informing you that the payout has failed.

On a successful request HTTP 200 status code, the response will include the following parameters:

{
  "status":"initial"
}

Business errors due to incorrect or missing parameters are returned with an HTTP 400 status code. The response will indicate which parameter is invalid or missing.

{
    "message": "The document field is required"
}