GEgetpaid
Payouts

Get a payout

Retrieve the payout details. Use the payout movements query endpoint to retrieve its assigned movements.

get/v2/payouts/{payout_id}

Request

Path parameters

payout_idstring id required

The unique identifier of the payout.

Response

OK

idstring id required

The unique identifier of the payout.

referencestring required

An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.

status'initiated' | 'movements_assigned' | 'transfer_initiated' | 'completed' | 'rejected' required

The status of the payout. See the list, transitions, and description of each status for more details.

amountinteger required

The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).

currencystring currency required

The processing currency code according to the ISO-4217 standard

created_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

updated_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

Example response

{
  "reference": "ORD-202510-0232",
  "account": {
    "id": "acc_44678r08jtm8zbt227tzhc4nw5"
  },
  "amount": 1000,
  "currency": "EUR",
  "created_at": "2025-09-01T22:05:48.479Z",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "cutoff": {
    "from": "2025-09-01T22:05:48.479Z",
    "to": "2025-09-01T22:05:48.479Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.