Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Payouts

Get a payout

Retrieves a payout by its id. Only payouts matching the live or test mode of the API key are visible.

get/payouts/{id}

Path parameters

idstring required

Unique identifier of the payout to retrieve.

Response

The payout.

idstring required

Unique identifier of the payout.

object'payout' required

Type of the object. Always payout.

amountinteger required

Value disbursed, in the smallest unit of the currency. CLP has no decimals, so amounts are in pesos. MXN amounts are in centavos.

created_atstring date-time required

ISO 8601 timestamp, in UTC, of when Fintoc created the payout.

currencystring required

Three-letter ISO 4217 currency code, returned in uppercase.

mode'test' | 'live' required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

status'in_progress' | 'succeeded' | 'canceled' | 'returned' required

Status of the payout. One of in_progress (Fintoc is processing the transfer), succeeded (the funds reached the recipient account), canceled (the payout failed or was canceled before sending the funds), or returned (the receiving institution returned the funds).

succeeded_atstring date-time nullable required

ISO 8601 timestamp, in UTC, of when the payout succeeded. null until the payout succeeds.

updated_atstring date-time required

ISO 8601 timestamp, in UTC, of when Fintoc last updated the payout.

Example response

{
  "id": "po_BO381oEATXonG6bj",
  "amount": 550000,
  "created_at": "2026-03-04T14:10:00Z",
  "currency": "CLP",
  "mode": "live",
  "recipient_account": {
    "holder_id": "111111111",
    "institution_id": "cl_banco_estado",
    "number": "987654321",
    "type": "checking_account"
  },
  "status": "succeeded",
  "succeeded_at": "2026-03-05T12:00:00Z",
  "updated_at": "2026-03-05T12:00:00Z"
}