Payout details

Get payout status and details.

You can check the payout status at any time:

GET /v1/payouts/{partner_code}
Host: query-binance.latamgateway.com
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

The response will be:

{
  "partner_code": "0001",
  "name": "Customer’s name",
  "birth": "1996-03-09",
  "email": "[email protected]",
  "phone": "44988772211",
  "document": "11122233344",
  "value": 10.23,
  "payment_method": "picpay",
  "notification_url": "https://your-system.com/webhook",
  "fee_payer": "merchant",
  "status": "done",
  "paid_at": "2024-01-01T12:01:00-03:00",
  "created_at": "2024-01-01T12:00:55-03:00",
  "payment_id": "provider-payment-id",
  "reason": null
}

Status meanings

Status	Meaning
initial	Payout is claimed.
processing	Payout sent to provider, waiting to be processed.
done	Money was successfully transfered to the customer.
error	Some error on the prcessing step.

Response 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	“Jon Snow”	Yes
document	Customer’s CPF ID.	String	“11122233344”	Yes
email	Customer’s email	String	"[email protected]"	No
phone	Customer’s phone	String	“44988776655”	No
birth	Customer's date of birth	String	“1996-03-09”	Yes
value	Amount for the payout	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

Resource not found

If the payout is not found, the response will be:

{
  "message": "Resource not found"
}

Internal error

If an internal error occurs, the response will be:

{
  "message": "Internal error. Please try again."
}