Picpay Payout

Making payouts to your customers using Picpay provider:

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

{
  "partner_code": "0001",
  "name": "Customer name",
  "document": "88899988811",
  "email": "[email protected]",
  "phone": "44988332211",
  "birth": "1999-12-30",
  "value": 10.23,
  "fee_payer": "merchant",
  "payment_method": "picpay",
  "notification_url": "https://yoursystem.com/notification-url"
}

The response will be:

{
  "status":"initial"
}

Params descriptions

Param	Description	Format	Example	Mandatory
partner_code	The ID from your system	String	“0001” or “my-code”. Any String	Yes
name	Customer’s full name	String	“Rick Sanches”	Yes
document	Customer’s personal ID	String	“88899988811”	Yes
email	Customer’s email	String	xxx	No
phone	Customer’s phone	String	xxx	No
birth	Customer’s birth	String	“YYYY-MM-DD”	Yes
value	Payout value	Float	10.23	Yes
fee_payer	Who is gonna pay the fees	String	“merchant”(Default) or “customer”	No
payment_method	Payout’s payment_method	String	“picpay”	Yes
notification_url	URL where our system is gonna send the Webhooks	String	https://your-domain.com/webhook	Yes