Skip to content
/Payouts

Kaito Core API (2.0.0)

Core payment operations: Quotes, Payments, Payouts, and FX.

Rail Types: CRYPTO_CRYPTO (on-chain), FIAT_CRYPTO (on-ramp), CRYPTO_FIAT (off-ramp), FIAT_FIAT (cross-border).

Typical Flow: Get rates -> Create quote -> Execute payment/payout -> Track status.

Destination Types (Payments): handle, phone, address.

Beneficiary Types (Payouts): bank_account, cash_pickup, mobile_money.

Download OpenAPI description
core.json
core.yaml
Overview
URL
https://developer.kai2.io/support
Kaito Developer Support
support@kai2.io
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://developer.kaito.io/_mock/core/
Production
https://api.kai2.io/
Sandbox
https://sandbox.api.kai2.io/

Quotes

Lock pricing and routing

Operations

Execution Plans

Multi-step routing plans

Operations

Payments

Execute payments (CRYPTO_CRYPTO, FIAT_CRYPTO)

Operations

Payouts

Execute payouts/off-ramp (CRYPTO_FIAT, FIAT_FIAT)

Operations

Create payout (off-ramp)

Request

Creates a payout for CRYPTO_FIAT or FIAT_FIAT flows.

Security
oAuth2
Headers
Idempotency-Keystring

A unique key to make POST requests idempotent.

Bodyapplication/jsonrequired
railTypestringrequired
Enum"FIAT_FIAT""CRYPTO_FIAT"
Example: "CRYPTO_FIAT"
amountnumberrequired
Example: 1000
currencystringrequired
Example: "GTQ"
beneficiaryobject(Beneficiary)required
beneficiary.​typestring(BeneficiaryType)required
Enum"bank_account""cash_pickup""mobile_money"
beneficiary.​valueobjectrequired
Example: {"bankCode":"BANK_X","accountNumber":"1234567890","name":"Recipient"}
beneficiary.​value.​property name*anyadditional property
quoteIdstring or null
metadataobject
curl -i -X POST \
  https://developer.kaito.io/_mock/core/v1/payouts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "railType": "CRYPTO_FIAT",
    "amount": 1000,
    "currency": "GTQ",
    "beneficiary": {
      "type": "bank_account",
      "value": {
        "bankCode": "BANK_X",
        "accountNumber": "1234567890",
        "name": "Recipient"
      }
    },
    "quoteId": "string",
    "metadata": {}
  }'

Responses

Payout created

Bodyapplication/json
payoutIdstringrequired
Example: "pyo_01JH..."
statusstring(PayoutStatus)required
Enum"created""pending""completed""failed""cancelled"
createdAtstring(date-time)required
railTypestringrequired
Enum"FIAT_FIAT""CRYPTO_FIAT"
amountnumberrequired
currencystringrequired
providerRefstring or null
Response
application/json
{
  "payoutId": "pyo_01JH...",
  "status": "created",
  "createdAt": "2019-08-24T14:15:22Z",
  "railType": "FIAT_FIAT",
  "amount": 0,
  "currency": "string",
  "providerRef": "string"
}

List payouts

Request

Security
oAuth2
Query
statusstring(PayoutStatus)
Enum"created""pending""completed""failed""cancelled"
railTypestring
Enum"FIAT_FIAT""CRYPTO_FIAT"
createdAfterstring(date-time)
createdBeforestring(date-time)
limitinteger
Default 50
cursorstring
curl -i -X GET \
  'https://developer.kaito.io/_mock/core/v1/payouts?status=created&railType=FIAT_FIAT&createdAfter=2019-08-24T14%3A15%3A22Z&createdBefore=2019-08-24T14%3A15%3A22Z&limit=50&cursor=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payouts list

Bodyapplication/json
itemsArray of objects(Payout)
paginationobject(Pagination)
Response
application/json
{
  "items": [
    { … }
  ],
  "pagination": {
    "nextCursor": "cursor_abc123"
  }
}

Get payout by ID

Request

Security
oAuth2
Path
payoutIdstringrequired
curl -i -X GET \
  'https://developer.kaito.io/_mock/core/v1/payouts/{payoutId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payout details

Bodyapplication/json
payoutIdstringrequired
Example: "pyo_01JH..."
statusstring(PayoutStatus)required
Enum"created""pending""completed""failed""cancelled"
createdAtstring(date-time)required
railTypestringrequired
Enum"FIAT_FIAT""CRYPTO_FIAT"
amountnumberrequired
currencystringrequired
providerRefstring or null
Response
application/json
{
  "payoutId": "pyo_01JH...",
  "status": "created",
  "createdAt": "2019-08-24T14:15:22Z",
  "railType": "FIAT_FIAT",
  "amount": 0,
  "currency": "string",
  "providerRef": "string"
}

FX Rates

Indicative exchange rates

Operations

FX Quotes

Firm FX quotes

Operations

Corridors

Supported corridors

Operations