Neodeos API (v1)

Download OpenAPI specification:Download

Batch

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

header Parameters

accountId	string
x-secretkey required	any Secret Key

Request Body schema: application/json

count required	integer <int32>
description required	string non-empty
batch required	string non-empty CSV batch, columns: PaymentMethodId,Amount,Currency,Reference
	object (WebhookConfig)
	object or null

Responses

Request samples

Payload

Content type

application/json

{"count": 0,
"description": "string",
"batch": "PaymentMethodId,Amount,Currency,Reference\nfc3fb5ff9e3b42c290c740c8772b40aa,123.3,USD,reference",
"webhook": {"url": "string",
"authorization": "string"
},
"metadata": {"property1": "string",
"property2": "string"
}
}

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"
}

Retrieves a single batch

path Parameters

batchId

required

string

header Parameters

accountId	string
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,FailureReason\nfc3fb5ff9e3b42c290c740c8772b40aa,123.3,USD,reference,",
"dateAdded": "2019-08-24T14:15:22Z"
}

Retrieves a single batch without transactions information

path Parameters

batchId

required

string

header Parameters

accountId	string
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"
}

Search for batches

query Parameters

Description	string
AddedAfter	string <date-time>
AddedBefore	string <date-time>
Limit	integer <int32>
Skip	integer <int32>

header Parameters

accountId	string
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,FailureReason\nfc3fb5ff9e3b42c290c740c8772b40aa,123.3,USD,reference,",
"dateAdded": "2019-08-24T14:15:22Z"
}

Charge

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

header Parameters

accountId	string
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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"reference": "string",
"paymentInformation": {"cardNumber": "string",
"expiryDate": "string",
"ccv": "string",
"cardholder": "string",
"threeDSServerTransID": "string",
"externalThreeDsData": {"property1": "string",
"property2": "string"
}
},
"capture": true,
"ip": "string",
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"firstName": "string",
"lastName": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment using a card number

header Parameters

accountId	string
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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"providerId": "string",
"reference": "string",
"paymentInformation": {"cardNumber": "string",
"expiryDate": "string",
"ccv": "string",
"cardholder": "string",
"threeDSServerTransID": "string",
"externalThreeDsData": {"property1": "string",
"property2": "string"
}
},
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment for a customer

header Parameters

accountId	string
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)

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"customerId": "string",
"reference": "string",
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment for a saved payment method

header Parameters

accountId	string
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)

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"paymentMethodId": "string",
"reference": "string",
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment for payment token

header Parameters

accountId	string
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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"token": "string",
"reference": "string",
"transfer": {"account": "string",
"amount": 0.1
},
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment using a bank account

header Parameters

accountId	string
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 (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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"amount": 0.1,
"currency": "string",
"providerId": "string",
"reference": "string",
"bankPaymentInformation": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

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
sortBy	string
limit	integer <int32>
skip	integer <int32>

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"limit": 0,
"skip": 0,
"count": 0,
"charges": [{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}
]
}

Retrieve a single charge

path Parameters

chargeId

required

string

header Parameters

accountId	string
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": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Refund a charge

path Parameters

chargeId

required

string

query Parameters

amount	number <double>
comment	string

header Parameters

accountId	string
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": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Capture a charge

path Parameters

chargeId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Request Body schema: application/json

amount

number or null <double>

Responses

Request samples

Payload

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": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Void a charge

path Parameters

chargeId

required

string

header Parameters

accountId	string
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": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Accept a payment for a network token

header Parameters

accountId	string
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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"networkTokenId": "string",
"amount": 0.1,
"currency": "string",
"providerId": "string",
"reference": "string",
"capture": true,
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"customerCode": "string",
"invoiceNumber": "string",
"initiator": "CUSTOMER",
"webhook": {"url": "string",
"authorization": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"threeDSNotificationUrl": "string"
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Crypto

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

header Parameters

accountId	string
x-secretkey required	any Secret Key

Request Body schema: application/json

amount required	number <double>
providerId required	string non-empty
required	object (WebhookConfig)
currency	string or null
cryptoCurrency	string or null Cryptocurrency to use for payment (BTC, ETH, USDC, USDT). Defaults to BTC for backward compatibility.
reference	string or null [ 0 .. 40 ] characters
ip	string or null
	object (Address)
	object (Order)
firstName	string or null [ 0 .. 40 ] characters
lastName	string or null [ 0 .. 40 ] characters
	object or null
descriptor	string or null
	object (Geolocation)

Responses

Request samples

Payload

Content type

application/json

{"amount": 0.1,
"providerId": "string",
"webhook": {"url": "string",
"authorization": "string"
},
"currency": "string",
"cryptoCurrency": "string",
"reference": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"order": {"orderNumber": "string",
"freightAmount": 0.1,
"dutyAmount": 0.1,
"items": [{"productCode": "string",
"commodityCode": "string",
"description": "string",
"quantity": 0,
"unitOfMeasure": "string",
"amount": 0.1,
"taxAmount": 0.1
}
]
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"descriptor": "string",
"geolocation": {"longitude": 0.1,
"latitude": 0.1
}
}

Response samples

Content type

application/json

{"chargeId": "string",
"providerChargeId": "string",
"amount": 0.1,
"providerId": "string",
"reference": "string",
"paymentInformation": {"paymentMethodId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"type": "string",
"displayType": "string",
"email": "string",
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
}
},
"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": [{"amount": 0.1,
"dateAdded": "2019-08-24T14:15:22Z",
"comment": "string"
}
],
"failedAttempts": [{"providerId": "string",
"dateAttempted": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"gatewayCode": "string",
"gatewayMessage": "string",
"isRetryable": true
}
],
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"threeDsVerified": true,
"authorisationAmount": 0.1,
"initiator": "string",
"ip": "string",
"ipInfo": {"ip": "string",
"hostname": "string",
"city": "string",
"region": "string",
"country": "string",
"loc": "string",
"org": "string",
"postal": "string",
"timezone": "string"
},
"visaInstallments": {"providerId": "string",
"visPlanId": "string",
"visPlanIdRef": "string",
"visAcceptedTAndCVersion": 0,
"visPlanName": "string",
"visNumberOfInstallments": 0,
"visTotalFees": 0.1,
"visTotalPlanCost": 0.1,
"visInstallmentFrequency": "string",
"visTermsAndConditions": [{"url": "string",
"version": 0,
"text": "string",
"languageCode": "string"
}
]
},
"descriptor": "string",
"threeDsRedirectUrl": "string",
"paymentTokenId": "string",
"cryptoAddress": "string",
"cryptoCurrency": "string"
}

Customer

Add a customer using a card number

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"providerId": "string",
"paymentInformation": {"cardNumber": "string",
"expiryDate": "string",
"ccv": "string",
"cardholder": "string",
"threeDSServerTransID": "string",
"externalThreeDsData": {"property1": "string",
"property2": "string"
}
},
"vaultCard": true,
"vaultExpireDate": "2019-08-24T14:15:22Z",
"vaultExpireSeconds": 0,
"skipExpiryDateValidation": true,
"metadata": {"property1": "string",
"property2": "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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Retrieve payment methods for a customer

path Parameters

customerId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

[{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}
]

Retrieve payment methods for a customer

path Parameters

customerId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

[{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}
]

Add a customer using a payment token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"token": "string",
"metadata": {"property1": "string",
"property2": "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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Add a customer using a multi-use provider token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"providerId": "string",
"providerToken": "string",
"providerTokenData": {"property1": "string",
"property2": "string"
},
"verify": true,
"metadata": {"property1": "string",
"property2": "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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Add a customer using a single-use provider token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"providerId": "string",
"providerToken": "string",
"providerTokenData": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Add a customer using a bank account

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"providerId": "string",
"bankPaymentInformation": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"metadata": {"property1": "string",
"property2": "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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Add a payment method using a bank account

path Parameters

customerId

required

string

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"bankPaymentInformation": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"setDefault": true
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a card

path Parameters

customerId

required

string

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"paymentInformation": {"cardNumber": "string",
"expiryDate": "string",
"ccv": "string",
"cardholder": "string",
"threeDSServerTransID": "string",
"externalThreeDsData": {"property1": "string",
"property2": "string"
}
},
"vaultCard": true,
"vaultExpireDate": "2019-08-24T14:15:22Z",
"vaultExpireSeconds": 0,
"ip": "string",
"setDefault": true,
"skipExpiryDateValidation": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a token

path Parameters

customerId

required

string

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"ip": "string",
"setDefault": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

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

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"limit": 0,
"skip": 0,
"count": 0,
"customers": [{"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"defaultPaymentMethod": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}
]
}

retrieve a single customer

path Parameters

customerId

required

string

header Parameters

accountId	string
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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Remove customer and remove all payment methods

path Parameters

customerId

required

string

header Parameters

accountId	string
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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

Update an existing customer

path Parameters

customerId

required

string

header Parameters

accountId	string
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

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"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": {"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"vaultId": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
},
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
}
}

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

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"limit": 0,
"skip": 0,
"count": 0,
"paymentMethods": [{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}
]
}

retrieve a single payment method

path Parameters

paymentMethodId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Remove payment method

path Parameters

paymentMethodId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Update a payment method

path Parameters

paymentMethodId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Request Body schema: application/json

required

object (UpdatePaymentMethodCardRequestInformation)

expiryDate	string or null
cardholder	string or null

Responses

Request samples

Payload

Content type

application/json

{"card": {"expiryDate": "string",
"cardholder": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a card

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"paymentInformation": {"cardNumber": "string",
"expiryDate": "string",
"ccv": "string",
"cardholder": "string",
"threeDSServerTransID": "string",
"externalThreeDsData": {"property1": "string",
"property2": "string"
}
},
"vaultCard": true,
"vaultExpireDate": "2019-08-24T14:15:22Z",
"vaultExpireSeconds": 0,
"ip": "string",
"setDefault": true,
"skipExpiryDateValidation": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a vault

header Parameters

accountId	string
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}$

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"paymentMethodId": "string",
"ccv": "string"
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"token": "string",
"ip": "string",
"setDefault": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a single-use provider token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"phone": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"ip": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"providerId": "string",
"providerToken": "string",
"providerTokenData": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a multi-use provider token

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"providerToken": "string",
"email": "string",
"providerTokenData": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
},
"verify": true
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Add a payment method using a bank account

header Parameters

accountId	string
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

Responses

Request samples

Payload

Content type

application/json

{"providerId": "string",
"bankPaymentInformation": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"firstName": "string",
"lastName": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"setDefault": true
}

Response samples

Content type

application/json

{"paymentMethodId": "string",
"customerId": "string",
"type": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"bankPayment": {"bankCode": "string",
"accountNumber": "string",
"accountName": "string"
},
"providerId": "string",
"providerType": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"email": "string",
"customer": {"customerId": "string",
"reference": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateRemoved": "2019-08-24T14:15:22Z"
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"vaultId": "string",
"payToStatus": "string",
"ip": "string",
"dateRemoved": "2019-08-24T14:15:22Z",
"providerPaymentMethodId": "string",
"providerPaymentMethodData": {"property1": "string",
"property2": "string"
},
"paymentTokenId": "string"
}

Provider

Add a provider

header Parameters

accountId	string
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

Payload

Content type

application/json

{"type": "string",
"name": "string",
"environment": "string",
"authenticationParameters": {"property1": "string",
"property2": "string"
},
"additionalParameters": {"property1": "string",
"property2": "string"
},
"providerCountry": "string",
"currency": "string"
}

Response samples

Content type

application/json

{"providerId": "string",
"type": "string",
"name": "string",
"environment": "string",
"authenticationParameters": {"property1": "string",
"property2": "string"
},
"additionalParameters": {"property1": "string",
"property2": "string"
},
"providerCountry": "string",
"costData": [{"isInternationalCard": true,
"cardScheme": "string",
"transactionCost": 0.1,
"transactionPercentage": 0.1
}
],
"hideConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"requireConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"fallbackProviderId": "string",
"currency": "string",
"maxCapability": "string",
"hasPartialRefund": true,
"fallbackProvider": {"id": "string",
"name": "string",
"type": "string",
"applyCurrencyConversion": true
},
"hasThreeDsCapability": true
}

Update an existing provider

path Parameters

providerId

required

string

header Parameters

accountId	string
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

Payload

Content type

application/json

{"name": "string",
"authenticationParameters": {"property1": "string",
"property2": "string"
},
"additionalParameters": {"property1": "string",
"property2": "string"
},
"providerCountry": "string",
"currency": "string"
}

Response samples

Content type

application/json

{"providerId": "string",
"type": "string",
"name": "string",
"environment": "string",
"authenticationParameters": {"property1": "string",
"property2": "string"
},
"additionalParameters": {"property1": "string",
"property2": "string"
},
"providerCountry": "string",
"costData": [{"isInternationalCard": true,
"cardScheme": "string",
"transactionCost": 0.1,
"transactionPercentage": 0.1
}
],
"hideConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"requireConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"fallbackProviderId": "string",
"currency": "string",
"maxCapability": "string",
"hasPartialRefund": true,
"fallbackProvider": {"id": "string",
"name": "string",
"type": "string",
"applyCurrencyConversion": true
},
"hasThreeDsCapability": true
}

Delete a provider

path Parameters

providerId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"providerId": "string",
"type": "string",
"name": "string",
"environment": "string",
"authenticationParameters": {"property1": "string",
"property2": "string"
},
"additionalParameters": {"property1": "string",
"property2": "string"
},
"providerCountry": "string",
"costData": [{"isInternationalCard": true,
"cardScheme": "string",
"transactionCost": 0.1,
"transactionPercentage": 0.1
}
],
"hideConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"requireConfiguration": [{"currency": "string",
"lessThanAmount": 0.1,
"greaterThanAmount": 0.1,
"applyCurrencyConversion": true
}
],
"fallbackProviderId": "string",
"currency": "string",
"maxCapability": "string",
"hasPartialRefund": true,
"fallbackProvider": {"id": "string",
"name": "string",
"type": "string",
"applyCurrencyConversion": true
},
"hasThreeDsCapability": true
}

Root

Return status message

Responses

Response samples

Content type

application/json

{"status": "string"
}

Subscription

Create a new subscription

header Parameters

accountId	string
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 or null <int32>
startDate	string or null <date-time>
	object (SubscriptionEnd)
	object (SubscriptionRetryPolicy)
	object (WebhookConfig)
	object or null

Responses

Request samples

Payload

Content type

application/json

{"paymentMethodId": "string",
"amount": 0.1,
"currency": "string",
"interval": "Day",
"frequency": 0,
"startDate": "2019-08-24T14:15:22Z",
"endAfter": {"amount": 0.1,
"count": 0,
"date": "2019-08-24T14:15:22Z"
},
"retry": {"maximum": 0,
"interval": "Hour",
"frequency": 0
},
"webhook": {"url": "string",
"authorization": "string"
},
"metadata": {"property1": "string",
"property2": "string"
}
}

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": {"amount": 0.1,
"count": 0,
"date": "2019-08-24T14:15:22Z"
},
"retry": {"maximum": 0,
"interval": "Hour",
"frequency": 0
},
"webhook": {"url": "string",
"authorization": "string"
},
"status": "Complete"
}

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

accountId	string
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": {"amount": 0.1,
"count": 0,
"date": "2019-08-24T14:15:22Z"
},
"retry": {"maximum": 0,
"interval": "Hour",
"frequency": 0
},
"webhook": {"url": "string",
"authorization": "string"
},
"status": "Complete"
}
]

Get subscription

path Parameters

subscriptionId

required

string

header Parameters

accountId	string
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": {"amount": 0.1,
"count": 0,
"date": "2019-08-24T14:15:22Z"
},
"retry": {"maximum": 0,
"interval": "Hour",
"frequency": 0
},
"webhook": {"url": "string",
"authorization": "string"
},
"status": "Complete"
}

Delete subscription

path Parameters

subscriptionId

required

string

header Parameters

accountId	string
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": {"amount": 0.1,
"count": 0,
"date": "2019-08-24T14:15:22Z"
},
"retry": {"maximum": 0,
"interval": "Hour",
"frequency": 0
},
"webhook": {"url": "string",
"authorization": "string"
},
"status": "Complete"
}

Token

Get token by Id

path Parameters

tokenId

required

string

header Parameters

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"tokenId": "string",
"accountId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"dateAdded": "2019-08-24T14:15:22Z",
"dateUsed": "2019-08-24T14:15:22Z",
"payToStatus": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"clickToPay": {"billingAddress": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"cardData": {"panBin": "string",
"panLastFour": "string",
"scheme": "string",
"paymentCardType": "string"
}
}
}

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

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"limit": 0,
"skip": 0,
"count": 0,
"tokens": [{"tokenId": "string",
"accountId": "string",
"card": {"cardNumber": "string",
"expiryDate": "string",
"cardholder": "string",
"type": "string",
"cardType": "string",
"cardIin": "string",
"ccvCheck": true,
"threeDSServerTransID": "string",
"iinData": {"scheme": "string",
"country": "string",
"issuer": "string",
"countryCode": "string",
"cardType": "string"
}
},
"provider": {"providerId": "string",
"type": "string",
"name": "string"
},
"dateAdded": "2019-08-24T14:15:22Z",
"dateUsed": "2019-08-24T14:15:22Z",
"payToStatus": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"clickToPay": {"billingAddress": {"line1": "string",
"line2": "string",
"city": "string",
"country": "string",
"postalCode": "string",
"state": "string"
},
"cardData": {"panBin": "string",
"panLastFour": "string",
"scheme": "string",
"paymentCardType": "string"
}
}
}
]
}

Transfer

Add a transfer

header Parameters

accountId	string
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

Payload

Content type

application/json

{"providerId": "string",
"groupReference": "string",
"chargeId": "string",
"transfers": [{"account": "string",
"amount": 0.1,
"currency": "string",
"message": "string",
"reference": "string"
}
]
}

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"
}
]

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

accountId	string
x-secretkey required	any Secret Key

Responses

Response samples

Content type

application/json

{"limit": 0,
"skip": 0,
"count": 0,
"transfers": [{"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"
}
]
}

Retrieve a single transfer

path Parameters

transferId

required

string

header Parameters

accountId	string
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

accountId	string
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

Payload

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

accountId	string
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

accountId	string
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"
}