Skip to main content
API docs by Redocly

Server API (v1)

Download OpenAPI specification:Download

Batch

Creates a batch of transactions to process by payment method. Request must be below 10Mb

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
count
required
integer <int32>
description
required
string [ 0 .. 100 ] characters
batch
required
string non-empty

CSV batch, columns: PaymentMethodId,Amount,Currency,Reference

object (WebhookConfig)
object or null

Responses

Request samples

Content type
application/json
{
  • "count": 0,
  • "description": "string",
  • "batch": "PaymentMethodId,Amount,Currency,Reference\nfc3fb5ff9e3b42c290c740c8772b40aa,123.3,AUD,reference",
  • "webhook": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "batchId": "string",
  • "count": 0,
  • "success": 0,
  • "failure": 0,
  • "description": "string",
  • "status": "string",
  • "progress": 0.1,
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Retrieves a single batch

path Parameters
batchId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "batchId": "string",
  • "count": 0,
  • "success": 0,
  • "failure": 0,
  • "description": "string",
  • "status": "string",
  • "progress": 0.1,
  • "results": "PaymentMethodId,Amount,Currency,Reference,Status,TransactionId,FailureReason,GatewayErrorCode,GatewayErrorResponse,IsRetryable\nfc3fb5ff9e3b42c290c740c8772b40aa,123.3,AUD,reference,IN_PROGRESS,fc3fb5ff9e3b42c290c740c8772b40ab,,,,",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Retrieves a single batch without transactions information

path Parameters
batchId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "batchId": "string",
  • "count": 0,
  • "success": 0,
  • "failure": 0,
  • "description": "string",
  • "status": "string",
  • "progress": 0.1,
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

Search for batches

query Parameters
Description
string
AddedAfter
string <date-time>
AddedBefore
string <date-time>
Limit
integer <int32>
Skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "batches": [
    ]
}

Charge

Accept a payment using a card number using the least cost provider

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
reference
string or null [ 0 .. 40 ] characters
object (CardRequestInformation)
capture
boolean
ip
string or null
object (Order)
object (Address)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
object (Geolocation)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "capture": true,
  • "ip": "string",
  • "order": {
    },
  • "address": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "geolocation": {
    }
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment using a card number

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
providerId
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
object (CardRequestInformation)
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
object (Geolocation)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "geolocation": {
    }
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment using a ApplePay

header Parameters
providerId
string
x-publickey
required
any

Public Key

Request Body schema: application/json
email
string or null
phone
string or null
required
object (AppleToken)
amount
required
number <double>
currency
string or null
descriptor
string or null
ip
string or null
userAgent
string or null
firstName
string or null
lastName
string or null
object (Order)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "token": {
    },
  • "amount": 0.1,
  • "currency": "string",
  • "descriptor": "string",
  • "ip": "string",
  • "userAgent": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "order": {
    },
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment for a customer

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
customerId
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null
lastName
string or null
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
object (Geolocation)
recurring
boolean or null

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "customerId": "string",
  • "reference": "string",
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "geolocation": {
    },
  • "recurring": true
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment for a saved payment method

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
paymentMethodId
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null
lastName
string or null
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
object (Geolocation)
recurring
boolean or null

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "paymentMethodId": "string",
  • "reference": "string",
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "geolocation": {
    },
  • "recurring": true
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment for payment token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
token
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
object (CheckoutTransfer)
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null
lastName
string or null
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
object (Geolocation)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "token": "string",
  • "reference": "string",
  • "transfer": {
    },
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "geolocation": {
    }
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment using a bank account

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
amount
required
number <double>
currency
string or null
providerId
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
required
object (BankPaymentInformationData)
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null
lastName
string or null
object or null
descriptor
string or null
threeDSNotificationUrl
string or null
object (Geolocation)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "providerId": "string",
  • "reference": "string",
  • "bankPaymentInformation": {
    },
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string",
  • "geolocation": {
    }
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Search for charges

query Parameters
Reference
string
ProviderId
string
AmountGreaterThan
number <double>
AmountLessThan
number <double>
CustomerId
string
Status
string
AddedAfter
string <date-time>
addedBefore
string <date-time>
PaymentMethodId
string
PaymentType
string
CardType
string
Currency
string
CardNumber
string
Cardholder
string
BatchId
string
SubscriptionId
string
sortBy
string
limit
integer <int32>
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "charges": [
    ]
}

Retrieve a single charge

path Parameters
chargeId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Refund a charge

path Parameters
chargeId
required
string
query Parameters
amount
number <double>
comment
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Capture a charge

path Parameters
chargeId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
amount
number or null <double>

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Void a charge

path Parameters
chargeId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Accept a payment for a network token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
networkTokenId
string or null
amount
required
number <double>
currency
string or null
providerId
required
string non-empty
reference
string or null [ 0 .. 40 ] characters
capture
boolean
ip
string or null
object (Address)
object (Order)
customerCode
string or null
invoiceNumber
string or null
initiator
string (Initiator)
Enum: "CUSTOMER" "MERCHANT"
object (WebhookConfig)
firstName
string or null
lastName
string or null
object or null
descriptor
string or null
threeDSNotificationUrl
string or null

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "networkTokenId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "providerId": "string",
  • "reference": "string",
  • "capture": true,
  • "ip": "string",
  • "address": {
    },
  • "order": {
    },
  • "customerCode": "string",
  • "invoiceNumber": "string",
  • "initiator": "CUSTOMER",
  • "webhook": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "descriptor": "string",
  • "threeDSNotificationUrl": "string"
}

Response samples

Content type
application/json
{
  • "chargeId": "string",
  • "providerChargeId": "string",
  • "amount": 0.1,
  • "providerId": "string",
  • "reference": "string",
  • "paymentInformation": {
    },
  • "customerId": "string",
  • "status": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "successDate": "2019-08-24T14:15:22Z",
  • "voidDate": "2019-08-24T14:15:22Z",
  • "refundedAmount": 0.1,
  • "estimatedCost": 0.1,
  • "estimatedCostCurrency": "string",
  • "currency": "string",
  • "refunds": [
    ],
  • "failedAttempts": [
    ],
  • "customer": {
    },
  • "provider": {
    },
  • "threeDsVerified": true,
  • "authorisationAmount": 0.1,
  • "initiator": "string",
  • "ip": "string",
  • "ipInfo": {
    },
  • "visaInstallments": {
    },
  • "descriptor": "string",
  • "threeDsRedirectUrl": "string",
  • "paymentTokenId": "string",
  • "subscriptionId": "string",
  • "metadata": {
    }
}

Customer

Add a customer using a card number

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
providerId
required
string non-empty
required
object (CardRequestInformation)
vaultCard
boolean
vaultExpireDate
string or null <date-time>
vaultExpireSeconds
integer or null <int32>
skipExpiryDateValidation
boolean
object or null
object (WebhookConfig)
createNetworkToken
boolean or null
verify
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "providerId": "string",
  • "paymentInformation": {
    },
  • "vaultCard": true,
  • "vaultExpireDate": "2019-08-24T14:15:22Z",
  • "vaultExpireSeconds": 0,
  • "skipExpiryDateValidation": true,
  • "metadata": {
    },
  • "webhook": {
    },
  • "createNetworkToken": true,
  • "verify": true
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Retrieve payment methods for a customer

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve payment methods for a customer

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a customer using a payment token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
token
required
string non-empty
object or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "token": "string",
  • "metadata": {
    },
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Add a customer using a payto agreement

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
required
object (NewPayToAgreement)
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "payToAgreement": {
    },
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Add a customer using a multi-use provider token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
providerId
required
string non-empty
providerToken
required
string non-empty
object or null
verify
boolean
object or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "providerId": "string",
  • "providerToken": "string",
  • "providerTokenData": {
    },
  • "verify": true,
  • "metadata": {
    },
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Add a customer using a single-use provider token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
providerId
required
string non-empty
providerToken
required
string non-empty
object or null
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "providerId": "string",
  • "providerToken": "string",
  • "providerTokenData": {
    },
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Add a customer using a bank account

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
providerId
required
string non-empty
required
object (NewBankPayment)
object or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "providerId": "string",
  • "bankPaymentInformation": {
    },
  • "metadata": {
    },
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Add a payment method using a bank account

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
required
object (NewBankPayment)
firstName
string or null
lastName
string or null
object or null
setDefault
boolean
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "bankPaymentInformation": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "setDefault": true,
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a card

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
required
object (CardRequestInformation)
vaultCard
boolean
vaultExpireDate
string or null <date-time>
vaultExpireSeconds
integer or null <int32>
ip
string or null
setDefault
boolean
skipExpiryDateValidation
boolean
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)
createNetworkToken
boolean or null
verify
boolean

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "paymentInformation": {
    },
  • "vaultCard": true,
  • "vaultExpireDate": "2019-08-24T14:15:22Z",
  • "vaultExpireSeconds": 0,
  • "ip": "string",
  • "setDefault": true,
  • "skipExpiryDateValidation": true,
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    },
  • "createNetworkToken": true,
  • "verify": true
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a token

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
token
required
string non-empty
ip
string or null
setDefault
boolean
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "ip": "string",
  • "setDefault": true,
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a payto agreement

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
payerName
required
string non-empty
object (PayIdDetails)
description
required
string non-empty
maximumAmount
required
integer <int32> [ 1 .. 9999 ]
providerId
required
string non-empty
ip
string or null
setDefault
boolean
fallbackPaymentMethodId
string or null
object (WebhookConfig)
object or null

Responses

Request samples

Content type
application/json
{
  • "payerName": "string",
  • "payerPayIdDetails": {
    },
  • "description": "string",
  • "maximumAmount": 1,
  • "providerId": "string",
  • "ip": "string",
  • "setDefault": true,
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Search for customers

query Parameters
Reference
string
Email
string
AddedAfter
string <date-time>
AddedBefore
string <date-time>
Search
string
limit
integer <int32>
skip
integer <int32>
SortBy
string
IncludeRemoved
boolean
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "customers": [
    ]
}

retrieve a single customer

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Remove customer and remove all payment methods

path Parameters
customerId
required
string
query Parameters
GatewayDelete
boolean
Default: true
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Update an existing customer

path Parameters
customerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
object (Address)
defaultPaymentMethodId
string or null

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "address": {
    },
  • "defaultPaymentMethodId": "string"
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "defaultPaymentMethod": {
    },
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "address": {
    }
}

Create a payment link

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
title
string or null
amount
number or null <double>
currency
string or null
allowedPaymentTypes
Array of strings or null
description
string or null
image
string or null
confirmationMessage
string or null
redirectUrl
string or null
callToAction
string (CallToAction)
Enum: "Pay" "Donate"
limitPayments
integer or null <int32>
invoiceId
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "allowedPaymentTypes": [
    ],
  • "description": "string",
  • "image": "string",
  • "confirmationMessage": "string",
  • "redirectUrl": "string",
  • "callToAction": "Pay",
  • "limitPayments": 0,
  • "invoiceId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "paymentLinkId": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "accountId": "string",
  • "publicKey": "string",
  • "title": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "allowedPaymentTypes": [
    ],
  • "description": "string",
  • "image": "string",
  • "confirmationMessage": "string",
  • "redirectUrl": "string",
  • "callToAction": "string",
  • "limitPayments": 0,
  • "countPayments": 0,
  • "invoiceId": "string",
  • "metadata": {
    }
}

Search for payment links

query Parameters
addedAfter
string <date-time>
addedBefore
string <date-time>
limit
integer <int32>
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "paymentLinks": [
    ],
  • "count": 0
}

Retrieves a single payment link

path Parameters
paymentLinkId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "paymentLinkId": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "accountId": "string",
  • "publicKey": "string",
  • "title": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "allowedPaymentTypes": [
    ],
  • "description": "string",
  • "image": "string",
  • "confirmationMessage": "string",
  • "redirectUrl": "string",
  • "callToAction": "string",
  • "limitPayments": 0,
  • "countPayments": 0,
  • "invoiceId": "string",
  • "metadata": {
    }
}

PaymentMethod

Search for payment methods

query Parameters
AddedAfter
string <date-time>
AddedBefore
string <date-time>
ProviderId
string
CustomerId
string
limit
integer <int32>
skip
integer <int32>
PaymentType
string
CardType
string
Search
string
SortBy
string
IncludeRemoved
boolean
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "paymentMethods": [
    ]
}

retrieve a single payment method

path Parameters
paymentMethodId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Remove payment method

path Parameters
paymentMethodId
required
string
query Parameters
GatewayDelete
boolean
Default: true
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Update a payment method

path Parameters
paymentMethodId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
required
object (UpdatePaymentMethodCardRequestInformation)
object or null

Responses

Request samples

Content type
application/json
{
  • "card": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a card

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
required
object (CardRequestInformation)
vaultCard
boolean
vaultExpireDate
string or null <date-time>
vaultExpireSeconds
integer or null <int32>
ip
string or null
setDefault
boolean
skipExpiryDateValidation
boolean
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)
createNetworkToken
boolean or null
verify
boolean

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "paymentInformation": {
    },
  • "vaultCard": true,
  • "vaultExpireDate": "2019-08-24T14:15:22Z",
  • "vaultExpireSeconds": 0,
  • "ip": "string",
  • "setDefault": true,
  • "skipExpiryDateValidation": true,
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    },
  • "createNetworkToken": true,
  • "verify": true
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a vault

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
paymentMethodId
required
string non-empty
ccv
string or null^[0-9]{3,4}$
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "paymentMethodId": "string",
  • "ccv": "string",
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a payto agreement

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
payerName
required
string non-empty
object (PayIdDetails)
description
required
string non-empty
maximumAmount
required
integer <int32> [ 1 .. 9999 ]
providerId
required
string non-empty
ip
string or null
setDefault
boolean
fallbackPaymentMethodId
string or null
object (WebhookConfig)
object or null

Responses

Request samples

Content type
application/json
{
  • "payerName": "string",
  • "payerPayIdDetails": {
    },
  • "description": "string",
  • "maximumAmount": 1,
  • "providerId": "string",
  • "ip": "string",
  • "setDefault": true,
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
token
required
string non-empty
ip
string or null
setDefault
boolean
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "ip": "string",
  • "setDefault": true,
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a single-use provider token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
email
string or null
phone
string or null
reference
string or null [ 0 .. 40 ] characters
firstName
string or null [ 0 .. 40 ] characters
lastName
string or null [ 0 .. 40 ] characters
ip
string or null
object (Address)
providerId
required
string non-empty
providerToken
required
string non-empty
object or null
object or null
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "phone": "string",
  • "reference": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "ip": "string",
  • "address": {
    },
  • "providerId": "string",
  • "providerToken": "string",
  • "providerTokenData": {
    },
  • "metadata": {
    },
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a multi-use provider token

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
providerToken
required
string non-empty
email
string or null
object or null
object or null
verify
boolean
fallbackPaymentMethodId
string or null

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "providerToken": "string",
  • "email": "string",
  • "providerTokenData": {
    },
  • "metadata": {
    },
  • "verify": true,
  • "fallbackPaymentMethodId": "string"
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Add a payment method using a bank account

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
required
string non-empty
required
object (NewBankPayment)
firstName
string or null
lastName
string or null
object or null
setDefault
boolean
fallbackPaymentMethodId
string or null
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "bankPaymentInformation": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "metadata": {
    },
  • "setDefault": true,
  • "fallbackPaymentMethodId": "string",
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "customerId": "string",
  • "type": "string",
  • "card": {
    },
  • "bankPayment": {
    },
  • "providerId": "string",
  • "providerType": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "customer": {
    },
  • "provider": {
    },
  • "payTo": {
    },
  • "networkToken": {
    },
  • "vaultId": "string",
  • "payToStatus": "string",
  • "ip": "string",
  • "dateRemoved": "2019-08-24T14:15:22Z",
  • "providerPaymentMethodId": "string",
  • "providerPaymentMethodData": {
    },
  • "token": "string",
  • "networkTokenId": "string",
  • "fallbackPaymentMethodId": "string",
  • "metadata": {
    }
}

Provider

Add a provider

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
type
required
string non-empty
name
required
string non-empty
environment
required
string non-empty SANDBOX|PRODUCTION
object or null
object or null
providerCountry
string or null
currency
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "environment": "string",
  • "authenticationParameters": {
    },
  • "additionalParameters": {
    },
  • "providerCountry": "string",
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "providerId": "string",
  • "type": "string",
  • "name": "string",
  • "environment": "string",
  • "authenticationParameters": {
    },
  • "additionalParameters": {
    },
  • "providerCountry": "string",
  • "costData": [
    ],
  • "hideConfiguration": [
    ],
  • "requireConfiguration": [
    ],
  • "fallbackProviderId": "string",
  • "currency": "string",
  • "maxCapability": "string",
  • "hasPartialRefund": true,
  • "fallbackProvider": {
    },
  • "hasThreeDsCapability": true
}

Update an existing provider

path Parameters
providerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
name
string or null
object or null
object or null
providerCountry
string or null
currency
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authenticationParameters": {
    },
  • "additionalParameters": {
    },
  • "providerCountry": "string",
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "providerId": "string",
  • "type": "string",
  • "name": "string",
  • "environment": "string",
  • "authenticationParameters": {
    },
  • "additionalParameters": {
    },
  • "providerCountry": "string",
  • "costData": [
    ],
  • "hideConfiguration": [
    ],
  • "requireConfiguration": [
    ],
  • "fallbackProviderId": "string",
  • "currency": "string",
  • "maxCapability": "string",
  • "hasPartialRefund": true,
  • "fallbackProvider": {
    },
  • "hasThreeDsCapability": true
}

Delete a provider

path Parameters
providerId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "providerId": "string",
  • "type": "string",
  • "name": "string",
  • "environment": "string",
  • "authenticationParameters": {
    },
  • "additionalParameters": {
    },
  • "providerCountry": "string",
  • "costData": [
    ],
  • "hideConfiguration": [
    ],
  • "requireConfiguration": [
    ],
  • "fallbackProviderId": "string",
  • "currency": "string",
  • "maxCapability": "string",
  • "hasPartialRefund": true,
  • "fallbackProvider": {
    },
  • "hasThreeDsCapability": true
}

Root

Return status message

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Settlement

Get a list of settlements for an account

query Parameters
startDate
string
endDate
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "settlementId": "string",
  • "settlementDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "providerId": "string",
  • "providerName": "string",
  • "chargeId": "string",
  • "amount": 0.1
}

Subscription

Create a new subscription

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
paymentMethodId
string or null
amount
required
number <double>
currency
string or null
interval
string (SubscriptionInterval)
Enum: "Day" "Week" "Month" "Year"
frequency
integer <int32>
startDate
string or null <date-time>
object (SubscriptionEnd)
object (SubscriptionRetryPolicy)
object (WebhookConfig)
object or null

Responses

Request samples

Content type
application/json
{
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "status": "Complete",
  • "metadata": {
    }
}

Get subscriptions

query Parameters
amountGreaterThan
number <double>
amountLessThan
number <double>
addedAfter
string <date-time>
addedBefore
string <date-time>
currency
string
status
string
sortBy
string
limit
integer <int32>
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get subscription

path Parameters
subscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "status": "Complete",
  • "metadata": {
    }
}

Delete subscription

path Parameters
subscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "status": "Complete",
  • "metadata": {
    }
}

/subscription/{subscriptionId}

path Parameters
subscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
amount
required
number <double>
currency
string or null
interval
string (SubscriptionInterval)
Enum: "Day" "Week" "Month" "Year"
frequency
integer <int32>
object (SubscriptionEnd)
object (SubscriptionRetryPolicy)
object (WebhookConfig)
object or null

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "status": "Complete",
  • "metadata": {
    }
}

Suspend/Re-activate subscription

path Parameters
subscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
status
string (SubscriptionStatus)
Enum: "Complete" "Active" "Cancelled" "Suspended"

Responses

Request samples

Content type
application/json
{
  • "status": "Complete"
}

Response samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "paymentMethodId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "interval": "Day",
  • "frequency": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endAfter": {
    },
  • "retry": {
    },
  • "webhook": {
    },
  • "status": "Complete",
  • "metadata": {
    }
}

Token

Get token by Id

path Parameters
tokenId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "tokenId": "string",
  • "accountId": "string",
  • "card": {
    },
  • "provider": {
    },
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "dateUsed": "2019-08-24T14:15:22Z",
  • "payToStatus": "string",
  • "metadata": {
    },
  • "clickToPay": {
    }
}

Search for tokens

query Parameters
providerId
string
addedAfter
string <date-time>
addedBefore
string <date-time>
sortBy
string
status
string
limit
integer <int32>
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "tokens": [
    ]
}

Transfer

Add a transfer

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
providerId
string or null
groupReference
string or null
chargeId
string or null
Array of objects or null (NewTransfer)

Responses

Request samples

Content type
application/json
{
  • "providerId": "string",
  • "groupReference": "string",
  • "chargeId": "string",
  • "transfers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Search for transfers

query Parameters
Reference
string
ProviderId
string
Status
string
AddedAfter
string <date-time>
AddedBefore
string <date-time>
limit
integer <int32>
SortBy
string
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "skip": 0,
  • "count": 0,
  • "transfers": [
    ]
}

Retrieve a single transfer

path Parameters
transferId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "transferId": "string",
  • "status": "string",
  • "reference": "string",
  • "groupReference": "string",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "totalAmount": 0.1,
  • "providerId": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "account": "string",
  • "chargeId": "string"
}

Vault

Create a new vault item

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
cardNumber
required
string non-empty
ccv
string or null
expireDate
string or null <date-time>
expireSeconds
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "cardNumber": "string",
  • "ccv": "string",
  • "expireDate": "2019-08-24T14:15:22Z",
  • "expireSeconds": 0
}

Response samples

Content type
application/json
{
  • "vaultId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "expireDate": "2019-08-24T14:15:22Z",
  • "maskedCardNumber": "string",
  • "hasCvv": true
}

Delete a vault item

path Parameters
vaultId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "vaultId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "expireDate": "2019-08-24T14:15:22Z",
  • "maskedCardNumber": "string",
  • "hasCvv": true
}

Get a vault item

path Parameters
vaultId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "vaultId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "expireDate": "2019-08-24T14:15:22Z",
  • "maskedCardNumber": "string",
  • "hasCvv": true,
  • "cardNumber": "string",
  • "ccv": "string"
}

Version

Current version of the API

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "released": "2019-08-24T14:15:22Z",
  • "region": "string"
}

WebhookSubscription

Create a new webhook subscription

header Parameters
x-secretkey
required
any

Secret Key

Request Body schema: application/json
url
string or null
authorization
string or null
types
Array of strings or null (WebhookType)
Enum: "Transaction" "Batch" "Subscription" "Customer" "PaymentMethod"

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authorization": "string",
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "webhookSubscriptionId": "string",
  • "accountId": "string",
  • "url": "string",
  • "authorization": "string",
  • "types": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dateRemoved": "2019-08-24T14:15:22Z"
}

Get webhook subscriptions

query Parameters
addedAfter
string <date-time>
addedBefore
string <date-time>
id
string
type
string
sortBy
string
limit
integer <int32>
skip
integer <int32>
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "webhookSubscriptions": [
    ],
  • "count": 0
}

Get webhook subscription by ID

path Parameters
webhookSubscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "webhookSubscriptionId": "string",
  • "accountId": "string",
  • "url": "string",
  • "authorization": "string",
  • "types": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dateRemoved": "2019-08-24T14:15:22Z"
}

Delete webhook subscription by ID

path Parameters
webhookSubscriptionId
required
string
header Parameters
x-secretkey
required
any

Secret Key

Responses

Response samples

Content type
application/json
{
  • "webhookSubscriptionId": "string",
  • "accountId": "string",
  • "url": "string",
  • "authorization": "string",
  • "types": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dateRemoved": "2019-08-24T14:15:22Z"
}