Send an off-ramp cash-out

Cashes out to a beneficiary’s real-world (non-CRYPTO) payment destination, executed asynchronously against a quote from POST /v1/quotes. paymentDestinationId must be a non-CRYPTO destination; crypto goes via P2P or swap. Pricing is never accepted from the caller: amount, receiveAmount, receiveCurrency, and the service commission are resolved server-side from the quote. Discover the acceptable purpose/sourceOfFunds values with GET /v1/payments/enums and GET /v1/payments/requirements. Returns 202.

POST

payments

offramp

curl --request POST \
  --url https://api.zeam.money/gw/v1/payments/offramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "idempotencyKey": "3d594650-3436-11e5-bf7f-0002a5d5c51b",
  "transactionId": "order-9950",
  "walletId": "66666666-6666-6666-6666-666666666666",
  "beneficiaryId": "77777777-7777-7777-7777-777777777777",
  "paymentDestinationId": "aaaa1111-2222-3333-4444-555566667777",
  "quoteId": "bbbb1111-2222-3333-4444-555566667777",
  "sendingAssetCode": "USDZ",
  "purpose": "FAMILY_SUPPORT",
  "sourceOfFunds": "SALARY"
}
'

{
  "transactionRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "accepted",
  "intentId": "<string>",
  "isIdempotent": true,
  "message": "<string>"
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Access token issued by POST /v1/auth/token.

x-zeam-auth

string

header

required

Application secret (the apiKey issued at registration), validated at the Kong edge.

Body

application/json

idempotencyKey

string

required

transactionId

string

required

walletId

string<uuid>

required

Source wallet.

beneficiaryId

string<uuid>

required

paymentDestinationId

string<uuid>

required

A non-CRYPTO payment destination.

quoteId

string<uuid>

required

A quote from POST /v1/quotes.

sendingAssetCode

string

required

Asset to send — bare code (e.g. USDZ). The issuer is resolved server-side from the asset registry.

Example:

"USDZ"

externalReference

string

Optional; defaults to idempotencyKey downstream.

purpose

string

Purpose of remittance. Discover values via GET /v1/payments/enums and /v1/payments/requirements.

sourceOfFunds

string

Sender source of funds, when the connector requires it.

beneficiarySourceOfFunds

string

Beneficiary source of funds, when the connector requires it.

Response

Off-ramp accepted for asynchronous processing.

A 202 means the submission was accepted for asynchronous execution, not that it settled. Track completion with the Transactions routes or webhooks.

transactionRecordId

string<uuid>

required

The transaction record id, used with GET /v1/transactions/{transactionId}.

status

string

required

Submission status; not a terminal transaction status.

Example:

"accepted"

intentId

string

Downstream intent id, when present.

isIdempotent

boolean

True when this response replays a prior submission with the same idempotencyKey.

message

string

Send a cross-asset swap to a beneficiary

List compliance vocabularies

Send an off-ramp cash-out

curl --request POST \
  --url https://api.zeam.money/gw/v1/payments/offramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "idempotencyKey": "3d594650-3436-11e5-bf7f-0002a5d5c51b",
  "transactionId": "order-9950",
  "walletId": "66666666-6666-6666-6666-666666666666",
  "beneficiaryId": "77777777-7777-7777-7777-777777777777",
  "paymentDestinationId": "aaaa1111-2222-3333-4444-555566667777",
  "quoteId": "bbbb1111-2222-3333-4444-555566667777",
  "sendingAssetCode": "USDZ",
  "purpose": "FAMILY_SUPPORT",
  "sourceOfFunds": "SALARY"
}
'

{
  "transactionRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "accepted",
  "intentId": "<string>",
  "isIdempotent": true,
  "message": "<string>"
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Overview

Auth

Wallets

Assets

Beneficiaries

Connectors

Quotes

Payments

Transactions

Webhooks

Send an off-ramp cash-out

Authorizations

Body

Response