Payment Methods

To create a customer payment using a Primary Transaction, you must include the paymentMethod object in the JSON call. Dependent on the requestType, you’ll make some changes to the paymentMethod object to reflect different payment instruments and transaction types.

To take a Card Payment, use the PaymentCardPaymentMethod:

  "paymentCard": {
    "number": "5424180279791732",
    "expiryDate": {
      "month": "03",
      "year": "21"
    "securityCode": "977"

To take a Token Payment, use the PaymentTokenPaymentMethod:

  "paymentToken": {
    "value": "1235325235236",
    "function": "DEBIT",
    "securityCode": "977"

Within the paymentMethod object, you’ll provide different values dependent on the payment method type being used for payment. This defines the payment instrument the customer is using to make the transaction. The available options available are defined below. These will be regularly updated as more payment methods become available.

Further information on the payload changes associated with each of these methods is accessed via clicking the paymentMethodType.

PAYMENT_CARDThe Payment Card payment method covers all Credit and Debit Card types and networks. Your merchant acquiring contract will tell you which of the payment networks you can accept payments for.
PAYMENT_TOKENThe Payment Token payment method enables you to use a token created by us, instead of the actual payment method details. More information is provided on using Tokens here.
SEPAA SEPA transaction enables the customer to pay you via a bank-to-bank request over the European SEPA network.
WALLETEnables payment via a Wallet transaction. Wallet transactions require a specific paymentMethod object. More information on this object is provided in the Wallet Payments section.

SEPA Transactions

To use the SepaSaleTransaction request type, the paymentMethod object is replaced by the sepa object. The sepa object includes all data points required to execute a sepa transaction. Sepa stands for the “Single European Payments Area”, and enables payments to be executed immediately between bank accounts at low cost. This capability is only enabled for domestic payments in Germany at present. Additional countries will be added in the near future.

You must be signed up for SEPA payments and have a mandate reference ID to supply in order to populate the mandate object.

The SEPA PaymentMethod Object is shown below:

  "sepa": {
    "iban": "DE34500100600032121604",
    "name": "Alan Turner",
    "country": "DEU",
    "email": "[email protected]",
    "mandate": {
      "reference": "3JLCSTIG",
      "url": "",
      "signatureDate": "2020-10-15",
      "type": "SINGLE"

Want a quick overview?