Create a payment quote
POST/api/v1/payments/quote
Initiate a new payment quote request with the provided details
Request
Header Parameters
ApiKey stringrequired
AccountId stringrequired
- application/json
Body
required
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
Currency for the payment quote request
country stringrequired
Country for the payment quote request
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
id uuidrequired
Unique ID of the payment quote
fee objectrequired
amount numberrequired
The specific monetary value that is being converted from in the currency exchange
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fee": {
"amount": 100,
"currency": "USD"
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unsupported Media Type
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
type uri
title string
status int32
detail string
instance uri
properties object
property name* object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Loading...