Request foreign exchange quote

post

https://sandbox-api-v2.dogpay.com/v2/openapi/openapi/fx/quote

Requests a real-time foreign exchange quote. Either sellAmount or buyAmount must be provided. Currently only T0 tenor is supported.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

buyAmount

string

Fixed buy amount. Mutually exclusive with sellAmount — specify the exact amount of target currency to buy, and the system calculates the required sell amount.

buyCcy

string

required

Buy currency

sellAmount

string

Fixed sell amount. Mutually exclusive with buyAmount — specify the exact amount of base currency to sell, and the system calculates the purchasable target currency amount.

sellCcy

string

required

Sell currency

tenor

string

enum

required

Settlement timing for the trade defines when funds are exchanged (T0: same-day, T1: next business day, T2: two business days after the trade date). Currently, only T0 settlement is supported.

Allowed:

businessType

string

enum

Business type: if left blank, the default is 04. If the user type is person (04: cw_2_cw ,09: cw_2_va,10: cw_2_budget, 11: cw_2_card,12: va_2_cw,13: card_2_cw,14: budget_2_cw), If the user type is enterprise, the default is 04.

Allowed:

Headers

dgp-entity-id

string

required

The unique identifier of the target entity. Mandatory for white-label customers to define the sub-entity context.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Quote successful

400Invalid request parameters

500Internal server error