Payout list

Get a list of your payouts:

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

{
  "from": "2022-05-01 12:00:00",
  "to": "2022-05-10 23:35:59",
  "status": "done",
  "payment_method": "picpay",
  "sort": "created_at",
  "direction": "desc",
  "page": 1,
  "per_page": 40
}

Params Descriptions

Field	Description	Value Type	Requirement	Default Value
from	Start date and time in the format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	String	Optional	Today at 00:00:00 -03:00
to	End date and time in the format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	String	Optional	Today at 23:59:59 -03:00
status	Status of the operation. Possible values: initial, processing, done, error	String	Optional	All
payment_method	Payment method to filter results. Currently supported: picpay	String	Optional	picpay
sort	Sort results by a specific field. Options: paid_at, created_at	String	Optional	created_at
direction	Sorting direction. Options: desc (descending), asc (ascending)	String	Optional	desc
page	Page number for pagination. Must be an integer >= 1	Integer	Optional	1
per_page	Number of results per page. Must be an integer >= 1. Maximum is 200	Integer	Optional	Maximum is 200

The response will be a list of payouts with the following format:

{
  "payouts": [
    {
      "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
    },
    {
      "partner_code": "0002",
      "name": "Customer’s name",
      "birth": "1996-03-09",
      "email": "[email protected]",
      "phone": "44988772211",
      "document": "11122233344",
      "value": 6.11,
      "payment_method": "picpay",
      "notification_url": "https://your-system.com/webhook",
      "fee_payer": "merchant",
      "status": "error",
      "paid_at": null,
      "created_at": "2024-01-01T12:00:55-03:00",
      "payment_id": null,
      "reason": "PicPay account not found for the customer."
    }
  ],
  "total_pages": 1,
  "current_page": 1,
  "per_page": 40
}

Response params descriptions

Param	Description	Value Type
partner_code	The ID from your system	String
name	Customer’s full name	String
document	Customer’s CPF ID.	String
email	Customer’s email	String
phone	Customer’s phone	String
birth	Customer's date of birth	String
value	Amount for the payout	Float
fee_payer	Who is gonna pay the fees	String
payment_method	Payout’s payment method	String
notification_url	URL where our system is gonna send the Webhooks	String