Skip to main content
POST
/
quotes
Create a quote
curl --request POST \
  --url https://api.zeam.app/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "direction": "send",
  "connectorId": "44444444-4444-4444-4444-444444444444",
  "amount": "100.00",
  "transactionType": "C2C"
}
'
{
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sendAmount": 123,
  "sendCurrency": "<string>",
  "receiveAmount": 123,
  "receiveCurrency": "<string>",
  "direction": "send",
  "rate": 123,
  "fee": 123,
  "feeCurrency": "<string>",
  "total": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "transactionType": "C2C",
  "fundingInstructions": {
    "network": "<string>",
    "destinationAccount": "<string>",
    "asset": {
      "code": "<string>",
      "issuer": "<string>"
    },
    "memoType": "<string>",
    "memo": "<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 (Kong apiKey) issued at registration.

Body

application/json
​
direction
enum<string>
required
Available options:
send,
receive
​
connectorId
string<uuid>
required
​
amount
string
required

Decimal string

​
transactionType
string
Example:

"C2C"

​
qr
object

Optional QR payload for QR-driven quotes.

Response

Quote created. (Connect returns 402 upstream on success; the gateway normalises this to 200.)

​
quoteId
string<uuid>
required
​
connectorId
string<uuid>
required
​
sendAmount
number
​
sendCurrency
string
​
receiveAmount
number
​
receiveCurrency
string
​
direction
string
Example:

"send"

​
rate
number
​
fee
number
​
feeCurrency
string
​
total
number
​
createdAt
string<date-time>
​
expiresAt
string<date-time>
​
transactionType
string
Example:

"C2C"

​
fundingInstructions
object