Skip to main content
POST
Create an off-ramp quote

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
connectorId
string<uuid>
required
amount
number
required

Recipient amount in the sending currency (fee-exclusive). Must be greater than 0.

transactionType
string

Transaction type, e.g. C2C, B2C, B2B.

Example:

"B2C"

Response

Quote created.

quoteId
string<uuid>
required
connectorId
string<uuid>
required
sendAmount
number

Amount debited in the sending currency, as confirmed by the connector.

sendCurrency
string
receiveAmount
number

Amount the beneficiary receives.

receiveCurrency
string
rate
number
fee
number

Zeam's fee for the connector, in feeCurrency.

feeCurrency
string
total
number

sendAmount plus fee.

expiresAt
string

ISO 8601 expiry. Quotes expire roughly two minutes after creation.