v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Payouts

GetPayout

Retrieves details of a specific payout identified by a payout ID. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

get/v2/payouts/{payout_id}

Path parameters

payout_idstring required

The ID of the payout to retrieve the information for.

Response

Success

Example response

{
  "payout": {
    "amount_money": {
      "amount": -103,
      "currency_code": "USD"
    },
    "arrival_date": "2022-03-24",
    "created_at": "2022-03-24T03:07:09Z",
    "destination": {
      "id": "bact:ZPp3oedR3AeEUNd3z7",
      "type": "BANK_ACCOUNT"
    },
    "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
    "location_id": "L88917AVBK2S5",
    "status": "PAID",
    "type": "BATCH",
    "updated_at": "2022-03-24T03:07:09Z",
    "version": 1
  }
}