POST/transactions/{userId}/cross-border/quote

Get Quote

Retrieves a foreign exchange quote for a cross-border payment.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`InstrumentId`	string	Required	—	Cross-border instrument ID.
`CounterpartyId`	string	Required	—	Counterparty ID.

Example request

{
  "InstrumentId": "{{instrumentId}}",
  "CounterpartyId": "{{counterpartyId}}"
}

{
  "InstrumentId": "{{instrumentId}}",
  "CounterpartyId": "{{counterpartyId}}"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	FX quote details including exchange rate, fees, and expiry.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "FeeAmount": "35",
    "Balance": "47944.75",
    "PayerInfo": {
      "payer_id": 4005,
      "payer_name": "Abu Dhabi Commercial Bank",
      "country": "ARE",
      "increment": 0.01,
      "precision": 2,
      "sender_receiver_model": "C2C",
      "maximum_amount": null,
      "minimum_amount": 3.68,
      "sender": [
        [
          "lastname",
          "code",
          "date_of_birth",
          "address",
          "firstname",
          "city",
          "country_iso_code"
        ]
      ],
      "receiver": [
        [
          "lastname",
          "firstname"
        ]
      ],
      "required_documents": [
        []
      ],
      "credit_party_identifier": [
        "iban"
      ]
    },
    "RateInfo": {
      "destination_currency": "AED",
      "rates": {
        "C2C": {
          "USD": [
            {
              "source_amount_max": null,
              "source_amount_min": 0,
              "wholesale_fx_rate": 0.27501701837984993,
              "fx_rate": 0.2770796460176988
            }
          ]
        }
      }
    },
    "FxRate": "0.2770796460176988",
    "WholesaleFxRate": "0.27501701837984993",
    "ProviderName": "thunes",
    "MinAmount": "1"
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "FeeAmount": "35",
    "Balance": "47944.75",
    "PayerInfo": {
      "payer_id": 4005,
      "payer_name": "Abu Dhabi Commercial Bank",
      "country": "ARE",
      "increment": 0.01,
      "precision": 2,
      "sender_receiver_model": "C2C",
      "maximum_amount": null,
      "minimum_amount": 3.68,
      "sender": [
        [
          "lastname",
          "code",
          "date_of_birth",
          "address",
          "firstname",
          "city",
          "country_iso_code"
        ]
      ],
      "receiver": [
        [
          "lastname",
          "firstname"
        ]
      ],
      "required_documents": [
        []
      ],
      "credit_party_identifier": [
        "iban"
      ]
    },
    "RateInfo": {
      "destination_currency": "AED",
      "rates": {
        "C2C": {
          "USD": [
            {
              "source_amount_max": null,
              "source_amount_min": 0,
              "wholesale_fx_rate": 0.27501701837984993,
              "fx_rate": 0.2770796460176988
            }
          ]
        }
      }
    },
    "FxRate": "0.2770796460176988",
    "WholesaleFxRate": "0.27501701837984993",
    "ProviderName": "thunes",
    "MinAmount": "1"
  }
}

Quotes are time-limited. Use Confirm Quote within the expiry window.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.