Skip to content

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

Param Mandatory Values Default
from false YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00) Today at 00:00:00 -03:00
to false YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00) Today at 23:59:59 -03:00
status false initial, processing, done, error All
payment_method false picpay picpay
sort false paid_at created_at (defaults according to status.) created_at
direction false desc or asc desc
page false Any integer >= 1 1
per_page false Any integer >= 1 Maximum is 200

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

{
  "orders":
  [
    {
      "partner_code": "0001",
      "name": "Customer’s name",
      "document": "88899988811",
      "email": "[email protected]",
      "phone": "44988772211",
      "birth": "2000-27-12",
      "value": 10.23,
      "payment_method": "picpay",
      "notification_url": "https://your-system.com/webhook",
      "fee_payer": "merchant",
      "status": "done",
      "paid_at": "2022-01-01 12:01:00",
      "created_at": "2022-01-01 12:00:55",
      "payment_id": "provider-payment-id",
      "reason": "error message if status is error"
    },
        {
      "partner_code": "0002",
      "name": "Customer’s name",
      "document": "88899988811",
      "email": "[email protected]",
      "phone": "44988772211",
      "birth": "2000-27-12",
      "value": 10.23,
      "payment_method": "picpay",
      "notification_url": "https://your-system.com/webhook",
      "fee_payer": "merchant",
      "status": "done",
      "paid_at": "2022-01-01 12:01:00",
      "created_at": "2022-01-01 12:00:55",
      "payment_id": "provider-payment-id",
      "reason": "error message if status is error"
    }
  ],
  "total_pages": 20,
  "current_page": 1,
  "per_page": 30
}

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 “Rick Sanches” Yes
document Customer’s personal ID String “88899988811” Yes
email Customer’s email String xxx No
phone Customer’s phone String “44988776655” 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