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

Created

application/json

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

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fee": {
    "amount": 100,
    "currency": "USD"
  }
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

415

Unsupported Media Type

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Loading...