Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Payouts

Fetch a payout

Fetch a payout

Required scope: business/payouts:read

get/v1/payouts/{payout_id}

Path parameters

payout_idstring required

The unique identifier of the payout.

The unique identifier of the payout.

Response

Successful Response

idstring required

The unique identifier of the payout.

status'failed' | 'paid' | 'sent' | 'unpaid' required
payout_type'fast' | 'instant' | 'standard' | 'weekly' required
created_atstring date-time required

The payout creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the payout was last modified in ISO 8601 format.

Example response

{
  "capital_repayment_amount": {
    "amount": 250,
    "currency": "ZAR"
  },
  "created_at": "2024-11-19T15:27:02+00:00",
  "fee_amount": {
    "amount": 350,
    "currency": "ZAR"
  },
  "gross_amount": {
    "amount": 12000,
    "currency": "ZAR"
  },
  "id": "1744288539-57db0a32-3cae-40af-a328-b22a09cfcb94",
  "net_amount": {
    "amount": 11400,
    "currency": "ZAR"
  },
  "payout_fees": [
    {
      "amount": {
        "amount": 27800,
        "currency": "ZAR"
      },
      "type": "initial"
    }
  ],
  "payout_type": "standard",
  "status": "paid",
  "updated_at": "2024-11-19T16:27:23+00:00"
}