Skip to main content
POST
/
v1
/
connect-quote
/
{direction}
Get a directional payment quote
curl --request POST \
  --url https://api.zeam.money/gw/v1/connect-quote/{direction} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '{}'
{
  "data": null,
  "status": 123,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token issued by the gateway. Source the token from one of:

  • POST /v1/public/auth/verify-otp (OTP user)
  • POST /v1/public/auth-connect/sign-in (Connect app)
  • OAuth (end-user mobile/web)

Include as Authorization: Bearer <token>.

​
x-zeam-auth
string
header
required

Connect secret for the Connect route group. Partners must include their issued connect secret (x-zeam-auth: <connect-secret>) on all /v1/connect-* calls.

Path Parameters

​
direction
enum<string>
required
Available options:
send,
receive

Body

application/json

The body is of type object.

Response

Missing, expired, or invalid credential.

Standard error envelope. Mirrors the success envelope shape but data is always null and message encodes "code: description".

​
data
any
required

Always null for error responses.

Example:

null

​
status
integer
required

Mirrors the HTTP status code.

Examples:

400

401

404

409

422

500

​
message
string
required

Format: 'code: description'.

Examples:

"invalid_input: field required"

"unauthorized: missing bearer token"

"not_found: resource not found"