API docs by Redocly

Xpate gateway API (1.0)

Download OpenAPI specification:Download

Xpate gateway API

Orders

Orders

Collection of orders in the specified period

Authorizations:
basic-auth
query Parameters
created_since
required
string <date-time>
created_until
required
string <date-time>

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add a new order

Authorizations:
basic-auth
Request Body schema: application/json
merchant_order_id
string

Merchant's internal order identifier

merchant_bulk_id
string

Merchant bulk ID (can be used to group transactions for payouts, if configured)

merchant_name
string

Merchant name (can be used for payouts, if configured)

merchant_iban
string^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,34}$

Merchant IBAN (can be used for payouts, if configured)

merchant_bic
string^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$

Merchant BIC (can be used for payouts, if configured)

expiration_period
string

Time interval (ISO 8601 / RFC 3339)

capture_mode
string
Enum: "manual" "delayed"

Can be manual or delayed, only available for methods that work with an authorization. Delayed requires the expiration_period to be present, it will then be captured at the time of expiration.

currency
required
string
Enum: "AED" "AFN" "ANG" "ARS" "AUD" "AWG" "AZN" "BBD" "BDT" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BZD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GTQ" "GYD" "HKD" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JMD" "JOD" "JPY" "KES" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MOP" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "SAR" "SCR" "SEK" "SGD" "SRD" "THB" "TND" "TRY" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "VND" "XCD" "XOF" "ZAR" "EEK" "LTL"

ISO 4217 currencies

amount
required
integer >= 1

Order amount (including VAT)

description
string
payment_methods
Array of strings non-empty

Limits the customer to only pay using the provided methods

Array of objects (Transactions)

A collection of transactions

return_url
string <uri>

Your customer will be redirected here after payment

webhook_url
string <uri>

Used for transaction updates

Array of objects (Order Line)
object (Customer)
object (Client)
object

Free-form data; add any properties you want to be stored with this order. The information will be returned when you retrieve to order status.

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Get a single order

Authorizations:
basic-auth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Update a single order

Authorizations:
basic-auth
path Parameters
id
required
string
Request Body schema: application/json
merchant_order_id
string

Merchant's internal order identifier

merchant_bulk_id
string

Merchant bulk ID (can be used to group transactions for payouts, if configured)

merchant_name
string

Merchant name (can be used for payouts, if configured)

merchant_iban
string^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,34}$

Merchant IBAN (can be used for payouts, if configured)

merchant_bic
string^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$

Merchant BIC (can be used for payouts, if configured)

expiration_period
string

Time interval (ISO 8601 / RFC 3339)

capture_mode
string
Enum: "manual" "delayed"

Can be manual or delayed, only available for methods that work with an authorization. Delayed requires the expiration_period to be present, it will then be captured at the time of expiration.

currency
required
string
Enum: "AED" "AFN" "ANG" "ARS" "AUD" "AWG" "AZN" "BBD" "BDT" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BZD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GTQ" "GYD" "HKD" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JMD" "JOD" "JPY" "KES" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MOP" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "SAR" "SCR" "SEK" "SGD" "SRD" "THB" "TND" "TRY" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "VND" "XCD" "XOF" "ZAR" "EEK" "LTL"

ISO 4217 currencies

amount
required
integer >= 1

Order amount (including VAT)

description
string
payment_methods
Array of strings non-empty

Limits the customer to only pay using the provided methods

Array of objects (Transactions)

A collection of transactions

return_url
string <uri>

Your customer will be redirected here after payment

webhook_url
string <uri>

Used for transaction updates

Array of objects (Order Line)
object (Customer)
object (Client)
object

Free-form data; add any properties you want to be stored with this order. The information will be returned when you retrieve to order status.

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Cancel an order (if possible)

Authorizations:
basic-auth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Collection of available refunds.

Authorizations:
basic-auth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add a new refund

Authorizations:
basic-auth
path Parameters
id
required
string
Request Body schema: application/json
amount
integer >= 1
description
string
Array of objects (Order Line reference) non-empty unique

List of Order Lines objects

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new capture

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create a capture when the latest version is sent. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
object (Order Line reference)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new void

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create a void when the latest version is sent. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
object (Order Line reference)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new capture

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create the capture when the version you send along is the latest version. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
amount
integer

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new void

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create the void when the version you send along is the latest version. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
amount
integer

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Refunds

Refunds

Collection of available refunds.

Authorizations:
basic-auth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add a new refund

Authorizations:
basic-auth
path Parameters
id
required
string
Request Body schema: application/json
amount
integer >= 1
description
string
Array of objects (Order Line reference) non-empty unique

List of Order Lines objects

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Transactions

Transactions

Add a new capture

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create a capture when the latest version is sent. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
object (Order Line reference)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new void

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create a void when the latest version is sent. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
object (Order Line reference)

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new capture

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create the capture when the version you send along is the latest version. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
amount
integer

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new void

Authorizations:
basic-auth
path Parameters
id
required
string
transaction_id
required
string
header Parameters
if-match
string

Only create the void when the version you send along is the latest version. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match

Request Body schema: application/json
description
string
amount
integer

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "amount": 995,
  • "client": {
    },
  • "created": "2016-07-04T11:41:55.635115+00:00",
  • "currency": "EUR",
  • "description": "Example order #1",
  • "id": "0125e02b-557c-4fb5-956a-d22662d71ad9",
  • "last_transaction_added": "2016-07-04T11:41:55.831655+00:00",
  • "merchant_id": "7131b462-1b7d-489f-aba9-de2f0eadc9dc",
  • "merchant_order_id": "EXAMPLE001",
  • "modified": "2016-07-04T11:41:56.215543+00:00",
  • "project_id": "1ef558ed-d77d-470d-b43b-c0f4a131bcef",
  • "return_url": "http://www.example.com/",
  • "status": "new",
  • "transactions": [
    ]
}

Add a new payment link

Authorizations:
basic-auth
path Parameters
id
required
string
Request Body schema: application/json
merchant_order_id
required
string

Merchant's internal order identifier

description
string

Description of the payment link

amount
required
integer >= 1

Order amount (including VAT)

currency
required
string (currency)
Enum: "AED" "AFN" "ANG" "ARS" "AUD" "AWG" "AZN" "BBD" "BDT" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BZD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GTQ" "GYD" "HKD" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JMD" "JOD" "JPY" "KES" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MOP" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "SAR" "SCR" "SEK" "SGD" "SRD" "THB" "TND" "TRY" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "VND" "XCD" "XOF" "ZAR" "EEK" "LTL"

ISO 4217 currencies

expiration_period
string

Time interval (ISO 8601 / RFC 3339)

payment_methods
Array of strings non-empty

Limits the customer to only pay using the provided methods

object

List of orders belonging to this payment link

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "merchant_order_id": "EXAMPLE001",
  • "amount": 995,
  • "currency": "EUR",
  • "description": "Example description",
  • "expiration_period": "P20D",
  • "id": "__PAYMENTLINK_ID__",
  • "payment_url": "https://api.example.com/paylink/__PAYMENTLINK_ID__/",
  • "completed": "2018-02-08T16:18:32.574222+00:00",
  • "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66",
  • "created": "2018-02-08T15:39:12.773776Z",
  • "modified": "2018-02-08T16:18:37.196467Z",
  • "orders": {
    },
  • "reason": "Completed",
  • "status": "completed"
}

Retrieve a single payment link

Authorizations:
basic-auth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "merchant_order_id": "EXAMPLE001",
  • "amount": 995,
  • "currency": "EUR",
  • "description": "Example description",
  • "expiration_period": "P20D",
  • "id": "__PAYMENTLINK_ID__",
  • "payment_url": "https://api.example.com/paylink/__PAYMENTLINK_ID__/",
  • "completed": "2018-02-08T16:18:32.574222+00:00",
  • "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66",
  • "created": "2018-02-08T15:39:12.773776Z",
  • "modified": "2018-02-08T16:18:37.196467Z",
  • "orders": {
    },
  • "reason": "Completed",
  • "status": "completed"
}

Webhooks

Webhooks

Handle a status changed message

Authorizations:
basic-auth
Request Body schema: application/json
event
any
Value: "status_changed"
project_id
string <uuid>
order_id
string <uuid>
order_status
any
Enum: "new" "processing" "error" "completed" "cancelled" "expired"

Responses

Request samples

Content type
application/json
{
  • "event": "status_changed",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "order_status": "new"
}