API Reference

Get a detailed, up-to-date look at the Unzer API reference.

Methods

AliPay

post /v1/types/alipay

(createWithoutCustomerInfo14)
Create AliPay payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/alipay/{id}

(getAliPayPaymentMethodResource)
Retrieve an existed AliPay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/alipay default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Apple Pay

post /v1/types/applepay

(createWithoutCustomerInfo113)
Create ApplePay payment method resource.
  • application/json
  • !application/json
Request body
ApplePayPaymentData
version (optional)
String
data (optional)
String
signature (optional)
String
header (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String

post /v1/types/applepay/

(createWithoutCustomerInfo121)
Create ApplePay payment method resource.
  • application/json
  • !application/json
Request body
ApplePayPaymentData
version (optional)
String
data (optional)
String
signature (optional)
String
header (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String

get /v1/types/applepay/{id}

(getApplePayPaymentMethodResource)
Retrieve an existed ApplePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/applepay default: null
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String

Bancontact

post /v1/types/bancontact

(createByMultipart1)
Create Bancontact payment method resource.
  • !application/json
  • application/json
Request body
Bancontact
holder (optional)
String
(optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
holder (optional)
String

get /v1/types/bancontact/{id}

(get2)
Retrieve an existed Bancontact payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/bancontact default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
holder (optional)
String

put /v1/types/bancontact/{id}

(updateByMultiPart1)
Update Bancontact payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/bancontact default: null
  • !application/json
  • application/json
Request body
Bancontact
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
holder (optional)
String

Basket

get /v1/baskets/{basketId}

(getBasket2)
Get basket resource api
Path parameters
basketId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "note" : "note",
  "basketItems" : [ {
    "quantity" : 0,
    "amountPerUnit" : 2.302136,
    "vat" : 14,
    "amountNet" : 7.0614014,
    "amountDiscount" : 6.0274563,
    "amountGross" : 5.962134,
    "title" : "title",
    "type" : "type",
    "participantId" : "participantId",
    "unit" : "unit",
    "subTitle" : "subTitle",
    "basketItemReferenceId" : "basketItemReferenceId",
    "imageUrl" : "imageUrl",
    "amountVat" : 5.637377
  }, {
    "quantity" : 0,
    "amountPerUnit" : 2.302136,
    "vat" : 14,
    "amountNet" : 7.0614014,
    "amountDiscount" : 6.0274563,
    "amountGross" : 5.962134,
    "title" : "title",
    "type" : "type",
    "participantId" : "participantId",
    "unit" : "unit",
    "subTitle" : "subTitle",
    "basketItemReferenceId" : "basketItemReferenceId",
    "imageUrl" : "imageUrl",
    "amountVat" : 5.637377
  } ],
  "canceledBasket" : [ {
    "amountTotalDiscount" : "amountTotalDiscount",
    "items" : [ {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    }, {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    } ],
    "amountTotalVat" : "amountTotalVat",
    "timestamp" : "timestamp"
  }, {
    "amountTotalDiscount" : "amountTotalDiscount",
    "items" : [ {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    }, {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    } ],
    "amountTotalVat" : "amountTotalVat",
    "timestamp" : "timestamp"
  } ],
  "orderId" : "s-bsk-XXX",
  "amountTotal" : "amountTotal",
  "id" : "id",
  "amountTotalDiscount" : "amountTotalDiscount",
  "currencyCode" : "EUR",
  "amountTotalGross" : "amountTotalGross",
  "amountTotalVat" : "amountTotalVat"
}
  • */*
Responses
200
OK
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"

get /v1/baskets/{basketId}/

(getBasket3)
Get basket resource api
Path parameters
basketId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "note" : "note",
  "basketItems" : [ {
    "quantity" : 0,
    "amountPerUnit" : 2.302136,
    "vat" : 14,
    "amountNet" : 7.0614014,
    "amountDiscount" : 6.0274563,
    "amountGross" : 5.962134,
    "title" : "title",
    "type" : "type",
    "participantId" : "participantId",
    "unit" : "unit",
    "subTitle" : "subTitle",
    "basketItemReferenceId" : "basketItemReferenceId",
    "imageUrl" : "imageUrl",
    "amountVat" : 5.637377
  }, {
    "quantity" : 0,
    "amountPerUnit" : 2.302136,
    "vat" : 14,
    "amountNet" : 7.0614014,
    "amountDiscount" : 6.0274563,
    "amountGross" : 5.962134,
    "title" : "title",
    "type" : "type",
    "participantId" : "participantId",
    "unit" : "unit",
    "subTitle" : "subTitle",
    "basketItemReferenceId" : "basketItemReferenceId",
    "imageUrl" : "imageUrl",
    "amountVat" : 5.637377
  } ],
  "canceledBasket" : [ {
    "amountTotalDiscount" : "amountTotalDiscount",
    "items" : [ {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    }, {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    } ],
    "amountTotalVat" : "amountTotalVat",
    "timestamp" : "timestamp"
  }, {
    "amountTotalDiscount" : "amountTotalDiscount",
    "items" : [ {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    }, {
      "quantity" : "quantity",
      "amountPerUnit" : 5.637377,
      "vat" : 60,
      "amountNet" : 2.302136,
      "amountDiscount" : 0.8008282,
      "amountGross" : 1.4658129,
      "title" : "title",
      "type" : "type",
      "participantId" : "participantId",
      "unit" : "unit",
      "subTitle" : "subTitle",
      "basketItemReferenceId" : "basketItemReferenceId",
      "imageUrl" : "imageUrl",
      "amountVat" : 5.962134
    } ],
    "amountTotalVat" : "amountTotalVat",
    "timestamp" : "timestamp"
  } ],
  "orderId" : "s-bsk-XXX",
  "amountTotal" : "amountTotal",
  "id" : "id",
  "amountTotalDiscount" : "amountTotalDiscount",
  "currencyCode" : "EUR",
  "amountTotalGross" : "amountTotalGross",
  "amountTotalVat" : "amountTotalVat"
}
  • */*
Responses
200
OK
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"

post /v1/baskets/

(registerBasket11)
Create basket resource api
  • application/json
  • !application/json
Request body
BasketModelV1
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(required)
Body Parameter
{
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String

post /v1/baskets

(registerBasket2)
Create basket resource api
  • application/json
  • !application/json
Request body
BasketModelV1
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(required)
Body Parameter
{
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String

put /v1/baskets/{basketId}/

(updateBasket1)
Update basket resource api
Path parameters
basketId (required)
Path Parameter — The parameter returned when the resource was created default: null
  • application/json
Request body
BasketModelV1
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(required)
Body Parameter
{
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String

put /v1/baskets/{basketId}

(updateBasket2)
Update basket resource api
Path parameters
basketId (required)
Path Parameter — The parameter returned when the resource was created default: null
  • application/json
  • !application/json
Request body
BasketModelV1
id (optional)
String
amountTotal (optional)
String
amountTotalGross (optional)
String
amountTotalDiscount (optional)
String
amountTotalVat (optional)
String
currencyCode (optional)
String
orderId
String
note (optional)
String
basketItems (optional)
basketItemReferenceId (optional)
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc"
quantity
Integer
Quantity of the basket item format: int32
amountDiscount (optional)
Float
Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer
Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float
Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float
NET amount per unit format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0. format: float
title
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
canceledBasket (optional)
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(required)
Body Parameter
{
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String

Basket Migration

get /v1/migration/baskets/{basketId}

(getBasket)
Get redirected to a v1 or v2 basket resource
Path parameters
basketId (required)
Path Parameter — The v1 or v2 parameter returned when the resource was created default: null
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
303
See Other
applicationContext (optional)
displayName (optional)
String
applicationName (optional)
String
startupDate (optional)
Long
format: int64
autowireCapableBeanFactory (optional)
Object
parent (optional)
displayName (optional)
String
applicationName (optional)
String
startupDate (optional)
Long
format: int64
autowireCapableBeanFactory (optional)
Object
parent (optional)
ApplicationContext
id (optional)
String
environment (optional)
Environment
beanDefinitionCount (optional)
Integer
format: int32
beanDefinitionNames (optional)
array[String]
parentBeanFactory (optional)
Object
classLoader (optional)
ApplicationContext_classLoader
id (optional)
String
environment (optional)
activeProfiles (optional)
array[String]
defaultProfiles (optional)
array[String]
beanDefinitionCount (optional)
Integer
format: int32
beanDefinitionNames (optional)
array[String]
parentBeanFactory (optional)
Object
classLoader (optional)
parent (optional)
ApplicationContext_classLoader_parent
defaultAssertionStatus (optional)
Boolean
servletContext (optional)
minorVersion (optional)
Integer
format: int32
attributeNames (optional)
Object
servlets (optional)
Object
sessionTrackingModes (optional)
set[String]
Enum:
sessionCookieConfig (optional)
String
majorVersion (optional)
Integer
format: int32
contextPath (optional)
String
filterRegistrations (optional)
array[String]
servletContextName (optional)
String
effectiveMajorVersion (optional)
Integer
format: int32
jspConfigDescriptor (optional)
String
effectiveSessionTrackingModes (optional)
set[String]
Enum:
defaultSessionTrackingModes (optional)
set[String]
Enum:
servletRegistrations (optional)
array[String]
requestCharacterEncoding (optional)
String
sessionTimeout (optional)
Integer
format: int32
virtualServerName (optional)
String
responseCharacterEncoding (optional)
String
servletNames (optional)
Object
initParameterNames (optional)
Object
effectiveMinorVersion (optional)
Integer
format: int32
serverInfo (optional)
String
classLoader (optional)
ApplicationContext_classLoader
contentType (optional)
String
requestContextAttribute (optional)
String
staticAttributes (optional)
map[String, Object]
exposePathVariables (optional)
Boolean
exposeContextBeansAsAttributes (optional)
Boolean
exposedContextBeanNames (optional)
array[String]
beanName (optional)
String
url (optional)
String
contextRelative (optional)
Boolean
http10Compatible (optional)
Boolean
exposeModelAttributes (optional)
Boolean
encodingScheme (optional)
String
statusCode (optional)
String
Enum:
100 CONTINUE
101 SWITCHING_PROTOCOLS
102 PROCESSING
103 CHECKPOINT
200 OK
201 CREATED
202 ACCEPTED
203 NON_AUTHORITATIVE_INFORMATION
204 NO_CONTENT
205 RESET_CONTENT
206 PARTIAL_CONTENT
207 MULTI_STATUS
208 ALREADY_REPORTED
226 IM_USED
300 MULTIPLE_CHOICES
301 MOVED_PERMANENTLY
302 FOUND
302 MOVED_TEMPORARILY
303 SEE_OTHER
304 NOT_MODIFIED
305 USE_PROXY
307 TEMPORARY_REDIRECT
308 PERMANENT_REDIRECT
400 BAD_REQUEST
401 UNAUTHORIZED
402 PAYMENT_REQUIRED
403 FORBIDDEN
404 NOT_FOUND
405 METHOD_NOT_ALLOWED
406 NOT_ACCEPTABLE
407 PROXY_AUTHENTICATION_REQUIRED
408 REQUEST_TIMEOUT
409 CONFLICT
410 GONE
411 LENGTH_REQUIRED
412 PRECONDITION_FAILED
413 PAYLOAD_TOO_LARGE
413 REQUEST_ENTITY_TOO_LARGE
414 URI_TOO_LONG
414 REQUEST_URI_TOO_LONG
415 UNSUPPORTED_MEDIA_TYPE
416 REQUESTED_RANGE_NOT_SATISFIABLE
417 EXPECTATION_FAILED
418 I_AM_A_TEAPOT
419 INSUFFICIENT_SPACE_ON_RESOURCE
420 METHOD_FAILURE
421 DESTINATION_LOCKED
422 UNPROCESSABLE_ENTITY
423 LOCKED
424 FAILED_DEPENDENCY
425 TOO_EARLY
426 UPGRADE_REQUIRED
428 PRECONDITION_REQUIRED
429 TOO_MANY_REQUESTS
431 REQUEST_HEADER_FIELDS_TOO_LARGE
451 UNAVAILABLE_FOR_LEGAL_REASONS
500 INTERNAL_SERVER_ERROR
501 NOT_IMPLEMENTED
502 BAD_GATEWAY
503 SERVICE_UNAVAILABLE
504 GATEWAY_TIMEOUT
505 HTTP_VERSION_NOT_SUPPORTED
506 VARIANT_ALSO_NEGOTIATES
507 INSUFFICIENT_STORAGE
508 LOOP_DETECTED
509 BANDWIDTH_LIMIT_EXCEEDED
510 NOT_EXTENDED
511 NETWORK_AUTHENTICATION_REQUIRED
expandUriTemplateVariables (optional)
Boolean
propagateQueryParams (optional)
Boolean
hosts (optional)
array[String]
propagateQueryProperties (optional)
Boolean
redirectView (optional)
Boolean
attributes (optional)
map[String, String]
attributesCSV (optional)
String
attributesMap (optional)
map[String, Object]

get /v1/migration/baskets/{basketId}/

(getBasket1)
Get redirected to a v1 or v2 basket resource
Path parameters
basketId (required)
Path Parameter — The v1 or v2 parameter returned when the resource was created default: null
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
303
See Other
applicationContext (optional)
displayName (optional)
String
applicationName (optional)
String
startupDate (optional)
Long
format: int64
autowireCapableBeanFactory (optional)
Object
parent (optional)
displayName (optional)
String
applicationName (optional)
String
startupDate (optional)
Long
format: int64
autowireCapableBeanFactory (optional)
Object
parent (optional)
ApplicationContext
id (optional)
String
environment (optional)
Environment
beanDefinitionCount (optional)
Integer
format: int32
beanDefinitionNames (optional)
array[String]
parentBeanFactory (optional)
Object
classLoader (optional)
ApplicationContext_classLoader
id (optional)
String
environment (optional)
activeProfiles (optional)
array[String]
defaultProfiles (optional)
array[String]
beanDefinitionCount (optional)
Integer
format: int32
beanDefinitionNames (optional)
array[String]
parentBeanFactory (optional)
Object
classLoader (optional)
parent (optional)
ApplicationContext_classLoader_parent
defaultAssertionStatus (optional)
Boolean
servletContext (optional)
minorVersion (optional)
Integer
format: int32
attributeNames (optional)
Object
servlets (optional)
Object
sessionTrackingModes (optional)
set[String]
Enum:
sessionCookieConfig (optional)
String
majorVersion (optional)
Integer
format: int32
contextPath (optional)
String
filterRegistrations (optional)
array[String]
servletContextName (optional)
String
effectiveMajorVersion (optional)
Integer
format: int32
jspConfigDescriptor (optional)
String
effectiveSessionTrackingModes (optional)
set[String]
Enum:
defaultSessionTrackingModes (optional)
set[String]
Enum:
servletRegistrations (optional)
array[String]
requestCharacterEncoding (optional)
String
sessionTimeout (optional)
Integer
format: int32
virtualServerName (optional)
String
responseCharacterEncoding (optional)
String
servletNames (optional)
Object
initParameterNames (optional)
Object
effectiveMinorVersion (optional)
Integer
format: int32
serverInfo (optional)
String
classLoader (optional)
ApplicationContext_classLoader
contentType (optional)
String
requestContextAttribute (optional)
String
staticAttributes (optional)
map[String, Object]
exposePathVariables (optional)
Boolean
exposeContextBeansAsAttributes (optional)
Boolean
exposedContextBeanNames (optional)
array[String]
beanName (optional)
String
url (optional)
String
contextRelative (optional)
Boolean
http10Compatible (optional)
Boolean
exposeModelAttributes (optional)
Boolean
encodingScheme (optional)
String
statusCode (optional)
String
Enum:
100 CONTINUE
101 SWITCHING_PROTOCOLS
102 PROCESSING
103 CHECKPOINT
200 OK
201 CREATED
202 ACCEPTED
203 NON_AUTHORITATIVE_INFORMATION
204 NO_CONTENT
205 RESET_CONTENT
206 PARTIAL_CONTENT
207 MULTI_STATUS
208 ALREADY_REPORTED
226 IM_USED
300 MULTIPLE_CHOICES
301 MOVED_PERMANENTLY
302 FOUND
302 MOVED_TEMPORARILY
303 SEE_OTHER
304 NOT_MODIFIED
305 USE_PROXY
307 TEMPORARY_REDIRECT
308 PERMANENT_REDIRECT
400 BAD_REQUEST
401 UNAUTHORIZED
402 PAYMENT_REQUIRED
403 FORBIDDEN
404 NOT_FOUND
405 METHOD_NOT_ALLOWED
406 NOT_ACCEPTABLE
407 PROXY_AUTHENTICATION_REQUIRED
408 REQUEST_TIMEOUT
409 CONFLICT
410 GONE
411 LENGTH_REQUIRED
412 PRECONDITION_FAILED
413 PAYLOAD_TOO_LARGE
413 REQUEST_ENTITY_TOO_LARGE
414 URI_TOO_LONG
414 REQUEST_URI_TOO_LONG
415 UNSUPPORTED_MEDIA_TYPE
416 REQUESTED_RANGE_NOT_SATISFIABLE
417 EXPECTATION_FAILED
418 I_AM_A_TEAPOT
419 INSUFFICIENT_SPACE_ON_RESOURCE
420 METHOD_FAILURE
421 DESTINATION_LOCKED
422 UNPROCESSABLE_ENTITY
423 LOCKED
424 FAILED_DEPENDENCY
425 TOO_EARLY
426 UPGRADE_REQUIRED
428 PRECONDITION_REQUIRED
429 TOO_MANY_REQUESTS
431 REQUEST_HEADER_FIELDS_TOO_LARGE
451 UNAVAILABLE_FOR_LEGAL_REASONS
500 INTERNAL_SERVER_ERROR
501 NOT_IMPLEMENTED
502 BAD_GATEWAY
503 SERVICE_UNAVAILABLE
504 GATEWAY_TIMEOUT
505 HTTP_VERSION_NOT_SUPPORTED
506 VARIANT_ALSO_NEGOTIATES
507 INSUFFICIENT_STORAGE
508 LOOP_DETECTED
509 BANDWIDTH_LIMIT_EXCEEDED
510 NOT_EXTENDED
511 NETWORK_AUTHENTICATION_REQUIRED
expandUriTemplateVariables (optional)
Boolean
propagateQueryParams (optional)
Boolean
hosts (optional)
array[String]
propagateQueryProperties (optional)
Boolean
redirectView (optional)
Boolean
attributes (optional)
map[String, String]
attributesCSV (optional)
String
attributesMap (optional)
map[String, Object]

Card

post /v1/types/card

(createWithoutCustomerInfo1)
Create CreditCard payment method resource.

Note: This API is restricted to be called directly by SAQ-A or SAQ-EP level merchant.
  • application/json
  • !application/json
Request body
Creditcard
number
String
expiryDate
String
format: MM/yyyy
cvc
String
brand (optional)
String
email (optional)
String
3ds (optional)
String
cardHolder (optional)
String
(required)
Body Parameter
{
  "3ds" : "{}",
  "method" : "method",
  "recurring" : true,
  "cardHolder" : "cardHolder",
  "type" : "type",
  "expiryDate" : "expiryDate",
  "number" : "number",
  "cvc" : "cvc",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "cardDetails" : {
    "issuerPhoneNumber" : "issuerPhoneNumber",
    "issuerName" : "issuerName",
    "issuerUrl" : "issuerUrl",
    "cardType" : "cardType",
    "countryIsoA2" : "countryIsoA2",
    "countryName" : "countryName",
    "account" : "account"
  },
  "customerId" : "customerId",
  "processing" : {
    "traceId" : "traceId",
    "shortId" : "shortId",
    "uniqueId" : "uniqueId"
  },
  "id" : "id",
  "brand" : "brand",
  "email" : "email"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
number (optional)
String
type (optional)
String
brand (optional)
String
email (optional)
String
3ds (optional)
Object
cvc (optional)
String
expiryDate (optional)
String
cardHolder (optional)
String
cardDetails (optional)
cardType (optional)
String
account (optional)
String
countryIsoA2 (optional)
String
countryName (optional)
String
issuerName (optional)
String
issuerUrl (optional)
String
issuerPhoneNumber (optional)
String
processing (optional)
uniqueId (optional)
String
shortId (optional)
String
traceId (optional)
String

get /v1/types/card/{id}

(getCardPaymentMethodResource)
Retrieve an existed CreditCard payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/card default: null
{
  "3ds" : "{}",
  "method" : "method",
  "recurring" : true,
  "cardHolder" : "cardHolder",
  "type" : "type",
  "expiryDate" : "expiryDate",
  "number" : "number",
  "cvc" : "cvc",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "cardDetails" : {
    "issuerPhoneNumber" : "issuerPhoneNumber",
    "issuerName" : "issuerName",
    "issuerUrl" : "issuerUrl",
    "cardType" : "cardType",
    "countryIsoA2" : "countryIsoA2",
    "countryName" : "countryName",
    "account" : "account"
  },
  "customerId" : "customerId",
  "processing" : {
    "traceId" : "traceId",
    "shortId" : "shortId",
    "uniqueId" : "uniqueId"
  },
  "id" : "id",
  "brand" : "brand",
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
number (optional)
String
type (optional)
String
brand (optional)
String
email (optional)
String
3ds (optional)
Object
cvc (optional)
String
expiryDate (optional)
String
cardHolder (optional)
String
cardDetails (optional)
cardType (optional)
String
account (optional)
String
countryIsoA2 (optional)
String
countryName (optional)
String
issuerName (optional)
String
issuerUrl (optional)
String
issuerPhoneNumber (optional)
String
processing (optional)
uniqueId (optional)
String
shortId (optional)
String
traceId (optional)
String

put /v1/types/card/{id}

(updateCard1)
Update CreditCard payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/card default: null
  • application/json
  • !application/json
Request body
UpdatedCreditcard
number
String
expiryDate
String
format: MM/yyyy
cvc
String
brand (optional)
String
email (optional)
String
cardHolder (optional)
String
(required)
Body Parameter
{
  "3ds" : "{}",
  "method" : "method",
  "recurring" : true,
  "cardHolder" : "cardHolder",
  "type" : "type",
  "expiryDate" : "expiryDate",
  "number" : "number",
  "cvc" : "cvc",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "cardDetails" : {
    "issuerPhoneNumber" : "issuerPhoneNumber",
    "issuerName" : "issuerName",
    "issuerUrl" : "issuerUrl",
    "cardType" : "cardType",
    "countryIsoA2" : "countryIsoA2",
    "countryName" : "countryName",
    "account" : "account"
  },
  "customerId" : "customerId",
  "processing" : {
    "traceId" : "traceId",
    "shortId" : "shortId",
    "uniqueId" : "uniqueId"
  },
  "id" : "id",
  "brand" : "brand",
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
number (optional)
String
type (optional)
String
brand (optional)
String
email (optional)
String
3ds (optional)
Object
cvc (optional)
String
expiryDate (optional)
String
cardHolder (optional)
String
cardDetails (optional)
cardType (optional)
String
account (optional)
String
countryIsoA2 (optional)
String
countryName (optional)
String
issuerName (optional)
String
issuerUrl (optional)
String
issuerPhoneNumber (optional)
String
processing (optional)
uniqueId (optional)
String
shortId (optional)
String
traceId (optional)
String

patch /v1/types/card/{id}

(updateCardEmail1)
Add/Update email of an existing CreditCard payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling PATCH /types/card default: null
  • application/json
  • !application/json
Request body
UpdatedEmailCreditcard
email
String
(optional)
Body Parameter
{
  "3ds" : "{}",
  "method" : "method",
  "recurring" : true,
  "cardHolder" : "cardHolder",
  "type" : "type",
  "expiryDate" : "expiryDate",
  "number" : "number",
  "cvc" : "cvc",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "cardDetails" : {
    "issuerPhoneNumber" : "issuerPhoneNumber",
    "issuerName" : "issuerName",
    "issuerUrl" : "issuerUrl",
    "cardType" : "cardType",
    "countryIsoA2" : "countryIsoA2",
    "countryName" : "countryName",
    "account" : "account"
  },
  "customerId" : "customerId",
  "processing" : {
    "traceId" : "traceId",
    "shortId" : "shortId",
    "uniqueId" : "uniqueId"
  },
  "id" : "id",
  "brand" : "brand",
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
number (optional)
String
type (optional)
String
brand (optional)
String
email (optional)
String
3ds (optional)
Object
cvc (optional)
String
expiryDate (optional)
String
cardHolder (optional)
String
cardDetails (optional)
cardType (optional)
String
account (optional)
String
countryIsoA2 (optional)
String
countryName (optional)
String
issuerName (optional)
String
issuerUrl (optional)
String
issuerPhoneNumber (optional)
String
processing (optional)
uniqueId (optional)
String
shortId (optional)
String
traceId (optional)
String

Customer

delete /v1/customers/{codeOrExternalId}

(delete1)
Delete a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId. default: null
{
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
Id of deleted resource

get /v1/customers/{codeOrExternalId}

(get3)
Fetch a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId. default: null
{
  "firstname" : "firstname",
  "companyInfo" : {
    "registrationType" : "registrationType",
    "commercialRegisterNumber" : "commercialRegisterNumber",
    "function" : "function",
    "commercialSector" : "commercialSector"
  },
  "mobile" : "mobile",
  "birthDate" : "birthDate",
  "lastname" : "lastname",
  "phone" : "phone",
  "customerId" : "customerId",
  "shippingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "company" : "company",
  "id" : "id",
  "salutation" : "salutation",
  "billingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
Customer's generated code by Unzer's Payment
lastname
String
Customer's lastname.
firstname
String
Customer's firstname
salutation (optional)
String
Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String
Company name
customerId (optional)
String
Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String
Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String
Customer's email
phone (optional)
String
Customer's phone
mobile (optional)
String
Customer's mobile
billingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
shippingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
companyInfo (optional)
registrationType (optional)
String
The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String
The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String
The identify your working function
commercialSector (optional)
String
The identify your working commercial sector

post /v1/customers

(multipartCreate1)
Store customer data to be used in authorize or charges calls
  • !application/json
  • application/json
Request body
CustomerModel
id (optional)
String
Customer's generated code by Unzer's Payment
lastname
String
Customer's lastname.
firstname
String
Customer's firstname
salutation (optional)
String
Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String
Company name
customerId (optional)
String
Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String
Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String
Customer's email
phone (optional)
String
Customer's phone
mobile (optional)
String
Customer's mobile
billingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
shippingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
companyInfo (optional)
registrationType (optional)
String
The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String
The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String
The identify your working function
commercialSector (optional)
String
The identify your working commercial sector
(required)
Body Parameter
{
  "firstname" : "firstname",
  "companyInfo" : {
    "registrationType" : "registrationType",
    "commercialRegisterNumber" : "commercialRegisterNumber",
    "function" : "function",
    "commercialSector" : "commercialSector"
  },
  "mobile" : "mobile",
  "birthDate" : "birthDate",
  "lastname" : "lastname",
  "phone" : "phone",
  "customerId" : "customerId",
  "shippingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "company" : "company",
  "id" : "id",
  "salutation" : "salutation",
  "billingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "email" : "email"
}
  • */*
Responses
201
Created
id (optional)
String
Customer's generated code by Unzer's Payment
lastname
String
Customer's lastname.
firstname
String
Customer's firstname
salutation (optional)
String
Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String
Company name
customerId (optional)
String
Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String
Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String
Customer's email
phone (optional)
String
Customer's phone
mobile (optional)
String
Customer's mobile
billingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
shippingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
companyInfo (optional)
registrationType (optional)
String
The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String
The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String
The identify your working function
commercialSector (optional)
String
The identify your working commercial sector

put /v1/customers/{codeOrExternalId}

(multipartUpdate2)
Update a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId. default: null
  • !application/json
  • application/json
Request body
CustomerModel
id (optional)
String
Customer's generated code by Unzer's Payment
lastname
String
Customer's lastname.
firstname
String
Customer's firstname
salutation (optional)
String
Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String
Company name
customerId (optional)
String
Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String
Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String
Customer's email
phone (optional)
String
Customer's phone
mobile (optional)
String
Customer's mobile
billingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
shippingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
companyInfo (optional)
registrationType (optional)
String
The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String
The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String
The identify your working function
commercialSector (optional)
String
The identify your working commercial sector
(optional)
Body Parameter
{
  "firstname" : "firstname",
  "companyInfo" : {
    "registrationType" : "registrationType",
    "commercialRegisterNumber" : "commercialRegisterNumber",
    "function" : "function",
    "commercialSector" : "commercialSector"
  },
  "mobile" : "mobile",
  "birthDate" : "birthDate",
  "lastname" : "lastname",
  "phone" : "phone",
  "customerId" : "customerId",
  "shippingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "company" : "company",
  "id" : "id",
  "salutation" : "salutation",
  "billingAddress" : {
    "zip" : "zip",
    "country" : "country",
    "city" : "city",
    "street" : "street",
    "name" : "name",
    "state" : "state"
  },
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
Customer's generated code by Unzer's Payment
lastname
String
Customer's lastname.
firstname
String
Customer's firstname
salutation (optional)
String
Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String
Company name
customerId (optional)
String
Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String
Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String
Customer's email
phone (optional)
String
Customer's phone
mobile (optional)
String
Customer's mobile
billingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
shippingAddress (optional)
name (optional)
String
Address first and last name (max. 81 chars). Required in case of billing address.
street (optional)
String
Address street (max. 64 chars). Required in case of billing address.
state (optional)
String
Address state in ISO 3166-2 format (max. 8 chars). Required in case of billing address.
zip (optional)
String
Address zip code (max. 10 chars). Required in case of billing address.
city (optional)
String
Address city (max. 30 chars). Required in case of billing address.
country (optional)
String
Address country in ISO A2 format (max. 2 chars). Required in case of billing address.
companyInfo (optional)
registrationType (optional)
String
The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String
The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String
The identify your working function
commercialSector (optional)
String
The identify your working commercial sector

Eps

post /v1/types/eps

(createWithoutCustomerInfo111)
Create EPS payment method resource.
  • application/json
  • !application/json
Request body
Eps
bic (optional)
String
(optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

get /v1/types/eps/{id}

(getEPSPaymentMethodResource)
Retrieve an existed EPS payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/eps default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

put /v1/types/eps/{id}

(updateEpsPaymentMethodResource1)
Update EPS payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/eps default: null
  • application/json
  • !application/json
Request body
Eps
bic (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

GiroPay

post /v1/types/giropay

(createWithoutCustomerInfo5)
Create Giropay payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/giropay/{id}

(getGiropayPaymentMethodResource)
Retrieve an existed Giropay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/giropay default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Google Pay

post /v1/types/googlepay

(createWithoutCustomerInfo114)
Create GooglePay payment method resource.
  • application/json
  • !application/json
Request body
GooglePayPaymentData
version (optional)
String
data (optional)
String
signature (optional)
String
header (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
apiVersionMinor (optional)
String
apiVersion (optional)
String
paymentMethodData (optional)
description (optional)
String
tokenizationData (optional)
String
type (optional)
String
info (optional)
String
shippingAddress (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
name (optional)
String
address1 (optional)
String
address2 (optional)
String
address3 (optional)
String
sortingCode (optional)
String
postalCode (optional)
String
countryCode (optional)
String
locality (optional)
String
administrativeArea (optional)
String
(required)
Body Parameter
{
  "expirationYear" : "expirationYear",
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "messageExpiration" : "messageExpiration",
  "recurring" : true,
  "messageId" : "messageId",
  "expirationMonth" : "expirationMonth",
  "eciIndicator" : "eciIndicator",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "paymentMethod" : "paymentMethod",
  "id" : "id",
  "pan" : "pan",
  "authMethod" : "authMethod",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate",
  "cryptogram" : "cryptogram"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String
messageId (optional)
String
messageExpiration (optional)
String
paymentMethod (optional)
String
expirationYear (optional)
String
expirationMonth (optional)
String
pan (optional)
String
authMethod (optional)
String
cryptogram (optional)
String
eciIndicator (optional)
String

post /v1/types/googlepay/

(createWithoutCustomerInfo122)
Create GooglePay payment method resource.
  • application/json
  • !application/json
Request body
GooglePayPaymentData
version (optional)
String
data (optional)
String
signature (optional)
String
header (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
apiVersionMinor (optional)
String
apiVersion (optional)
String
paymentMethodData (optional)
description (optional)
String
tokenizationData (optional)
String
type (optional)
String
info (optional)
String
shippingAddress (optional)
ephemeralPublicKey (optional)
String
publicKeyHash (optional)
String
transactionId (optional)
String
name (optional)
String
address1 (optional)
String
address2 (optional)
String
address3 (optional)
String
sortingCode (optional)
String
postalCode (optional)
String
countryCode (optional)
String
locality (optional)
String
administrativeArea (optional)
String
(required)
Body Parameter
{
  "expirationYear" : "expirationYear",
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "messageExpiration" : "messageExpiration",
  "recurring" : true,
  "messageId" : "messageId",
  "expirationMonth" : "expirationMonth",
  "eciIndicator" : "eciIndicator",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "paymentMethod" : "paymentMethod",
  "id" : "id",
  "pan" : "pan",
  "authMethod" : "authMethod",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate",
  "cryptogram" : "cryptogram"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String
messageId (optional)
String
messageExpiration (optional)
String
paymentMethod (optional)
String
expirationYear (optional)
String
expirationMonth (optional)
String
pan (optional)
String
authMethod (optional)
String
cryptogram (optional)
String
eciIndicator (optional)
String

get /v1/types/googlepay/{id}

(getGooglePayPaymentMethodResource)
Retrieve an existed GooglePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/googlepay default: null
{
  "expirationYear" : "expirationYear",
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "messageExpiration" : "messageExpiration",
  "recurring" : true,
  "messageId" : "messageId",
  "expirationMonth" : "expirationMonth",
  "eciIndicator" : "eciIndicator",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "paymentMethod" : "paymentMethod",
  "id" : "id",
  "pan" : "pan",
  "authMethod" : "authMethod",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate",
  "cryptogram" : "cryptogram"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String
messageId (optional)
String
messageExpiration (optional)
String
paymentMethod (optional)
String
expirationYear (optional)
String
expirationMonth (optional)
String
pan (optional)
String
authMethod (optional)
String
cryptogram (optional)
String
eciIndicator (optional)
String

get /v1/types/googlepay/{id}/

(getGooglePayPaymentMethodResource1)
Retrieve an existed GooglePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/googlepay default: null
{
  "expirationYear" : "expirationYear",
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "messageExpiration" : "messageExpiration",
  "recurring" : true,
  "messageId" : "messageId",
  "expirationMonth" : "expirationMonth",
  "eciIndicator" : "eciIndicator",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "paymentMethod" : "paymentMethod",
  "id" : "id",
  "pan" : "pan",
  "authMethod" : "authMethod",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate",
  "cryptogram" : "cryptogram"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
applicationPrimaryAccountNumber (optional)
String
applicationExpirationDate (optional)
String
currencyCode (optional)
String
transactionAmount (optional)
String
messageId (optional)
String
messageExpiration (optional)
String
paymentMethod (optional)
String
expirationYear (optional)
String
expirationMonth (optional)
String
pan (optional)
String
authMethod (optional)
String
cryptogram (optional)
String
eciIndicator (optional)
String

Hire Purchase Debit

get /v1/types/hire-purchase-direct-debit/{id}

(getCardPaymentMethodResource1)
Retrieve an existed Hire-Purchase payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/hire-purchase-direct-debit default: null
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

get /v1/types/hire-purchase-direct-debit/plans

(getPlans)
Retreive available installment plans for a given purchaseAmount and orderDate.

Example: /v1/types/hire-purchase-direct-debit/plans?amount=100&currency=EUR&orderDate=2019-03-21&effectiveInterest=5.99
Query parameters
amount (optional)
Query Parameter — Total amount of the order. default: null
currency (optional)
Query Parameter — The currency of the order has been submitted. default: null
orderDate (optional)
Query Parameter — The timestamp the order has been submitted. default: null
dayOfPurchase (optional)
Query Parameter — The date of purchase the order has been submitted. default: null
effectiveInterest (required)
Query Parameter — Target effective interest rate in Percentage. default: null
{
  "code" : "code",
  "description" : "description",
  "entity" : [ {
    "feePerRate" : 9.301444243932576,
    "monthlyRate" : 3.616076749251911,
    "nominalInterestRate" : 2.3021358869347655,
    "feeFirstRate" : 7.061401241503109,
    "totalAmount" : 5.962133916683182,
    "totalInterestAmount" : 1.4658129805029452,
    "lastRate" : 2.027123023002322,
    "installmentRates" : [ {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    }, {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    } ],
    "dayOfPurchase" : "dayOfPurchase",
    "totalPurchaseAmount" : 6.027456183070403,
    "orderDate" : "orderDate",
    "effectiveInterestRate" : 5.637376656633329,
    "numberOfRates" : 0
  }, {
    "feePerRate" : 9.301444243932576,
    "monthlyRate" : 3.616076749251911,
    "nominalInterestRate" : 2.3021358869347655,
    "feeFirstRate" : 7.061401241503109,
    "totalAmount" : 5.962133916683182,
    "totalInterestAmount" : 1.4658129805029452,
    "lastRate" : 2.027123023002322,
    "installmentRates" : [ {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    }, {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    } ],
    "dayOfPurchase" : "dayOfPurchase",
    "totalPurchaseAmount" : 6.027456183070403,
    "orderDate" : "orderDate",
    "effectiveInterestRate" : 5.637376656633329,
    "numberOfRates" : 0
  } ]
}
  • */*
Responses
200
OK
code (optional)
String
description (optional)
String
entity (optional)
numberOfRates (optional)
Long
format: int64
dayOfPurchase (optional)
String
orderDate (optional)
String
totalPurchaseAmount (optional)
BigDecimal
totalInterestAmount (optional)
BigDecimal
totalAmount (optional)
BigDecimal
effectiveInterestRate (optional)
BigDecimal
nominalInterestRate (optional)
BigDecimal
feeFirstRate (optional)
BigDecimal
feePerRate (optional)
BigDecimal
monthlyRate (optional)
BigDecimal
lastRate (optional)
BigDecimal
installmentRates (optional)
date (optional)
String
numberOfInterest (optional)
BigDecimal
amountOfRepayment (optional)
BigDecimal
rate (optional)
BigDecimal
totalRemainingAmount (optional)
BigDecimal
timePassedInYears (optional)
BigDecimal
type (optional)
String
rateIndex (optional)
BigDecimal
accumulatedInterest (optional)
Object
ultimo (optional)
Boolean

post /v1/types/hire-purchase-direct-debit

(multipartCreateWithoutCustomerInfo1)
Create Hire-Purchase payment method resource.
  • !application/json
  • application/json
Request body
HirePurchaseDD
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String
numberOfRates
String
dayOfPurchase
String
totalPurchaseAmount
String
totalInterestAmount
String
totalAmount
String
effectiveInterestRate
String
nominalInterestRate
String
feeFirstRate
String
feePerRate
String
monthlyRate
String
lastRate
String
(required)
Body Parameter
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

put /v1/types/hire-purchase-direct-debit/{id}

(updateBankInformation1)
Update Hire-Purchase payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/hire-purchase-direct-debit default: null
  • application/json
  • !application/json
Request body
HirePurchaseDDUpdateRequest
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

Ideal

post /v1/types/ideal

(createWithoutCustomerInfo112)
Create Ideal payment method resource.
  • application/json
  • !application/json
Request body
Ideal
bic (optional)
String
(optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

get /v1/types/ideal/{id}

(getidealPaymentMethodResource)
Retrieve an existed Ideal payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/ideal default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

put /v1/types/ideal/{id}

(updateIdealPaymentMethodResource1)
Update Ideal payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/ideal default: null
  • application/json
  • !application/json
Request body
Ideal
bic (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
bic (optional)
String

Installment Secured

get /v1/types/installment-secured/{id}

(getCardPaymentMethodResource2)
Retrieve an existed Installment-Secured payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/installment-secured default: null
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

get /v1/types/installment-secured/plans

(getPlans1)
Retreive available installment plans for a given purchaseAmount and orderDate.

Example: /v1/types/installment-secured/plans?amount=100&currency=EUR&orderDate=2019-03-21&effectiveInterest=5.99
Query parameters
amount (optional)
Query Parameter — Total amount of the order. default: null
currency (optional)
Query Parameter — The currency of the order has been submitted. default: null
orderDate (optional)
Query Parameter — The timestamp the order has been submitted. default: null
dayOfPurchase (optional)
Query Parameter — The date of purchase the order has been submitted. default: null
effectiveInterest (required)
Query Parameter — Target effective interest rate in Percentage. default: null
{
  "code" : "code",
  "description" : "description",
  "entity" : [ {
    "feePerRate" : 9.301444243932576,
    "monthlyRate" : 3.616076749251911,
    "nominalInterestRate" : 2.3021358869347655,
    "feeFirstRate" : 7.061401241503109,
    "totalAmount" : 5.962133916683182,
    "totalInterestAmount" : 1.4658129805029452,
    "lastRate" : 2.027123023002322,
    "installmentRates" : [ {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    }, {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    } ],
    "dayOfPurchase" : "dayOfPurchase",
    "totalPurchaseAmount" : 6.027456183070403,
    "orderDate" : "orderDate",
    "effectiveInterestRate" : 5.637376656633329,
    "numberOfRates" : 0
  }, {
    "feePerRate" : 9.301444243932576,
    "monthlyRate" : 3.616076749251911,
    "nominalInterestRate" : 2.3021358869347655,
    "feeFirstRate" : 7.061401241503109,
    "totalAmount" : 5.962133916683182,
    "totalInterestAmount" : 1.4658129805029452,
    "lastRate" : 2.027123023002322,
    "installmentRates" : [ {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    }, {
      "date" : "date",
      "ultimo" : true,
      "totalRemainingAmount" : 1.0246457001441578,
      "rate" : 1.2315135367772556,
      "numberOfInterest" : 4.145608029883936,
      "timePassedInYears" : 1.4894159098541704,
      "accumulatedInterest" : "{}",
      "type" : "type",
      "amountOfRepayment" : 7.386281948385884,
      "rateIndex" : 6.84685269835264
    } ],
    "dayOfPurchase" : "dayOfPurchase",
    "totalPurchaseAmount" : 6.027456183070403,
    "orderDate" : "orderDate",
    "effectiveInterestRate" : 5.637376656633329,
    "numberOfRates" : 0
  } ]
}
  • */*
Responses
200
OK
code (optional)
String
description (optional)
String
entity (optional)
numberOfRates (optional)
Long
format: int64
dayOfPurchase (optional)
String
orderDate (optional)
String
totalPurchaseAmount (optional)
BigDecimal
totalInterestAmount (optional)
BigDecimal
totalAmount (optional)
BigDecimal
effectiveInterestRate (optional)
BigDecimal
nominalInterestRate (optional)
BigDecimal
feeFirstRate (optional)
BigDecimal
feePerRate (optional)
BigDecimal
monthlyRate (optional)
BigDecimal
lastRate (optional)
BigDecimal
installmentRates (optional)
date (optional)
String
numberOfInterest (optional)
BigDecimal
amountOfRepayment (optional)
BigDecimal
rate (optional)
BigDecimal
totalRemainingAmount (optional)
BigDecimal
timePassedInYears (optional)
BigDecimal
type (optional)
String
rateIndex (optional)
BigDecimal
accumulatedInterest (optional)
Object
ultimo (optional)
Boolean

post /v1/types/installment-secured

(multipartCreateWithoutCustomerInfo2)
Create Installment-Secured payment method resource.
  • !application/json
  • application/json
Request body
InstallmentSecured
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String
numberOfRates
String
dayOfPurchase
String
totalPurchaseAmount
String
totalInterestAmount
String
totalAmount
String
effectiveInterestRate
String
nominalInterestRate
String
feeFirstRate
String
feePerRate
String
monthlyRate
String
lastRate
String
(required)
Body Parameter
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

put /v1/types/installment-secured/{id}

(updateBankInformation2)
Update Installment-Secured payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/installment-secured default: null
  • application/json
  • !application/json
Request body
InstallmentSecuredUpdateRequest
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "feePerRate" : "feePerRate",
  "recurring" : true,
  "monthlyRate" : "monthlyRate",
  "nominalInterestRate" : "nominalInterestRate",
  "invoiceDate" : "invoiceDate",
  "invoiceDueDate" : "invoiceDueDate",
  "feeFirstRate" : "feeFirstRate",
  "accountHolder" : "accountHolder",
  "totalAmount" : "totalAmount",
  "totalInterestAmount" : "totalInterestAmount",
  "lastRate" : "lastRate",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "iban" : "iban",
  "customerId" : "customerId",
  "id" : "id",
  "dayOfPurchase" : "dayOfPurchase",
  "totalPurchaseAmount" : "totalPurchaseAmount",
  "bic" : "bic",
  "orderDate" : "orderDate",
  "effectiveInterestRate" : "effectiveInterestRate",
  "numberOfRates" : "numberOfRates"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
accountHolder (optional)
String
orderDate (optional)
String
numberOfRates (optional)
String
dayOfPurchase (optional)
String
totalPurchaseAmount (optional)
String
totalInterestAmount (optional)
String
totalAmount (optional)
String
effectiveInterestRate (optional)
String
nominalInterestRate (optional)
String
feeFirstRate (optional)
String
feePerRate (optional)
String
monthlyRate (optional)
String
lastRate (optional)
String
invoiceDate (optional)
String
invoiceDueDate (optional)
String

Invoice

post /v1/types/invoice

(createWithoutCustomerInfo6)
Create Invoice payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/invoice/{id}

(getCardPaymentMethodResource5)
Retrieve an existed Invoice payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/invoice default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Invoice Factoring

post /v1/types/invoice-factoring

(createWithoutCustomerInfo8)
Create Invoice-Factoring payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/invoice-factoring/{id}

(getInvoiceFactoringPaymentMethodResource)
Retrieve an existed Invoice-Factoring payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/invoice-factoring default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Invoice Guaranteed

post /v1/types/invoice-guaranteed

(createWithoutCustomerInfo7)
Create Invoice-Guaranteed payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/invoice-guaranteed/{id}

(getCardPaymentMethodResource6)
Retrieve an existed Invoice-Guaranteed payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/invoice-guaranteed default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Invoice Secured

post /v1/types/invoice-secured

(createWithoutCustomerInfo9)
Create Invoice-Secured payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/invoice-secured/{id}

(getInvoiceFactoringPaymentMethodResource1)
Retrieve an existed Invoice-Secured payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/invoice-secured default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

LinkPay

post /v1/linkpay/{aliasOrId}/authorize

(authorizeLinkPayPage1)
Path parameters
aliasOrId (required)
Path Parameter — default: null
  • application/json
  • !application/json
Request body
LinkPayModel
version
String
amount
String
currency
String
orderId (optional)
String
invoiceId (optional)
String
typeId (optional)
String
resources (optional)
customerId (optional)
String
returnUrl
String
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/linkpay/{aliasOrId}/charge

(chargeLinkPayPage1)
Path parameters
aliasOrId (required)
Path Parameter — default: null
  • application/json
  • !application/json
Request body
LinkPayModel
version
String
amount
String
currency
String
orderId (optional)
String
invoiceId (optional)
String
typeId (optional)
String
resources (optional)
customerId (optional)
String
returnUrl
String
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

delete /v1/linkpay/{id}

(delete)
Path parameters
id (required)
Path Parameter — default: null
Responses
200
OK

get /v1/linkpay/{id}

(get)
Path parameters
id (required)
Path Parameter — default: null
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
200
OK
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

post /v1/linkpay/charge/

(initCharge11)
  • application/json
  • !application/json
Request body
LinkPayRequest
alias (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
orderId (optional)
String
invoiceId (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

post /v1/linkpay/charge

(initCharge2)
  • application/json
  • !application/json
Request body
LinkPayRequest
alias (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
orderId (optional)
String
invoiceId (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

post /v1/linkpay/authorize/

(multipartInitAuthorize11)
  • !application/json
  • application/json
Request body
LinkPayRequest
alias (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
orderId (optional)
String
invoiceId (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

post /v1/linkpay/authorize

(multipartInitAuthorize2)
  • !application/json
  • application/json
Request body
LinkPayRequest
alias (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
orderId (optional)
String
invoiceId (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

put /v1/linkpay/{id}

(multipartUpdate1)
Path parameters
id (required)
Path Parameter — default: null
  • !application/json
  • application/json
Request body
LinkPayUpdateRequest
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
orderId (optional)
String
invoiceId (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
additionalAttributes (optional)
map[String, String]
intention (optional)
String
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "expires" : "expires",
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "oneTimeUse" : "oneTimeUse",
  "successfullyProcessed" : "successfullyProcessed",
  "invoiceIdRequired" : "invoiceIdRequired",
  "orderIdRequired" : "orderIdRequired",
  "alias" : "alias",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "version" : "version",
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "intention" : "intention",
  "card3ds" : "card3ds",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
200
OK
id (optional)
String
redirectUrl (optional)
String
version (optional)
String
alias (optional)
String
orderId (optional)
String
invoiceId (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
expires (optional)
String
intention (optional)
String
paymentReference (optional)
String
additionalAttributes (optional)
map[String, String]
orderIdRequired (optional)
String
invoiceIdRequired (optional)
String
oneTimeUse (optional)
String
successfullyProcessed (optional)
String
excludeTypes (optional)
array[String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE

Merchant Keypair

post /v1/keypair/applepay/certificates/{certificateId}/activate

(activateApplePayCertificate)
Activate a certicate as a default using certificate.
Path parameters
certificateId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

post /v1/keypair/googlepay/certificates/{certificateId}/activate

(activateGooglePayCertificate)
Activate a certicate as a default using certificate.
Path parameters
certificateId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair/applepay/certificates/{certificateId}

(getApplePayCertification)
Get your registered Apple Pay's certificate.
Path parameters
certificateId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair/applepay/privatekeys/{id}

(getApplePrivateKey)
Get your registered Apple Pay's private-key.
Path parameters
id (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair/applepay/privatekeys/{id}/

(getApplePrivateKey1)
Get your registered Apple Pay's private-key.
Path parameters
id (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair

(getAvailablePaymentMethodTypes)
Provides the public key of the used private key as well as a list of the payment types available for the merchant.
{
  "captchaFeatureEnable" : "captchaFeatureEnable",
  "availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
  "publicKey" : "publicKey",
  "login" : "login",
  "isAllowedPaypalOT" : "isAllowedPaypalOT",
  "merchantName" : "merchantName",
  "privateKey" : "privateKey",
  "senderId" : "senderId",
  "password" : "password",
  "validateBasket" : "validateBasket",
  "enableCrossChannelReferencing" : "enableCrossChannelReferencing",
  "secureLevel" : "secureLevel",
  "alias" : "alias",
  "merchantAddress" : "merchantAddress",
  "enableMandatory3dsEmail" : "enableMandatory3dsEmail",
  "paymentTypes" : [ {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  }, {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  } ],
  "cof" : "cof",
  "coreId" : "coreId"
}
  • */*
Responses
200
OK
publicKey (optional)
String
privateKey (optional)
String
senderId (optional)
String
login (optional)
String
password (optional)
String
secureLevel (optional)
String
alias (optional)
String
merchantName (optional)
String
merchantAddress (optional)
String
paymentTypes (optional)
supports (optional)
array[String]
type (optional)
String
allowCustomerTypes (optional)
String
googleMerchantId (optional)
String
allowCreditTransaction (optional)
Boolean
3ds (optional)
Boolean
availablePaymentTypes (optional)
array[String]
cof (optional)
String
validateBasket (optional)
String
captchaFeatureEnable (optional)
String
coreId (optional)
String
isAllowedPaypalOT (optional)
String
enableMandatory3dsEmail (optional)
String
enableCrossChannelReferencing (optional)
String

get /v1/keypair/types

(getAvailablePaymentMethodTypesWithTypeInformation)
Provides the public key of the used private key as well as a detailed list of the payment types available for the merchant.
{
  "captchaFeatureEnable" : "captchaFeatureEnable",
  "availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
  "publicKey" : "publicKey",
  "login" : "login",
  "isAllowedPaypalOT" : "isAllowedPaypalOT",
  "merchantName" : "merchantName",
  "privateKey" : "privateKey",
  "senderId" : "senderId",
  "password" : "password",
  "validateBasket" : "validateBasket",
  "enableCrossChannelReferencing" : "enableCrossChannelReferencing",
  "secureLevel" : "secureLevel",
  "alias" : "alias",
  "merchantAddress" : "merchantAddress",
  "enableMandatory3dsEmail" : "enableMandatory3dsEmail",
  "paymentTypes" : [ {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  }, {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  } ],
  "cof" : "cof",
  "coreId" : "coreId"
}
  • */*
Responses
200
OK
publicKey (optional)
String
privateKey (optional)
String
senderId (optional)
String
login (optional)
String
password (optional)
String
secureLevel (optional)
String
alias (optional)
String
merchantName (optional)
String
merchantAddress (optional)
String
paymentTypes (optional)
supports (optional)
array[String]
type (optional)
String
allowCustomerTypes (optional)
String
googleMerchantId (optional)
String
allowCreditTransaction (optional)
Boolean
3ds (optional)
Boolean
availablePaymentTypes (optional)
array[String]
cof (optional)
String
validateBasket (optional)
String
captchaFeatureEnable (optional)
String
coreId (optional)
String
isAllowedPaypalOT (optional)
String
enableMandatory3dsEmail (optional)
String
enableCrossChannelReferencing (optional)
String

get /v1/keypair/googlepay/certificates/{certificateId}

(getGooglePayCertification)
Get your registered Google Pay's certificate.
Path parameters
certificateId (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair/googlepay/privatekeys/{id}

(getGooglePrivateKey)
Get your registered Google Pay's private-key.
Path parameters
id (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

get /v1/keypair/googlepay/privatekeys/{id}/

(getGooglePrivateKey1)
Get your registered Google Pay's private-key.
Path parameters
id (required)
Path Parameter — The parameter returned when the resource was created default: null
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

put /v1/keypair/renew

(regenerateKeypair)
Change the private key, the public key will remain the same. It can only be triggered using the private key as parameter.
{
  "captchaFeatureEnable" : "captchaFeatureEnable",
  "availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
  "publicKey" : "publicKey",
  "login" : "login",
  "isAllowedPaypalOT" : "isAllowedPaypalOT",
  "merchantName" : "merchantName",
  "privateKey" : "privateKey",
  "senderId" : "senderId",
  "password" : "password",
  "validateBasket" : "validateBasket",
  "enableCrossChannelReferencing" : "enableCrossChannelReferencing",
  "secureLevel" : "secureLevel",
  "alias" : "alias",
  "merchantAddress" : "merchantAddress",
  "enableMandatory3dsEmail" : "enableMandatory3dsEmail",
  "paymentTypes" : [ {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  }, {
    "allowCreditTransaction" : true,
    "3ds" : true,
    "allowCustomerTypes" : "allowCustomerTypes",
    "googleMerchantId" : "googleMerchantId",
    "supports" : [ {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    }, {
      "brands" : [ "brands", "brands" ],
      "channel" : "channel",
      "currency" : [ "currency", "currency" ],
      "countries" : [ "countries", "countries" ]
    } ],
    "type" : "type"
  } ],
  "cof" : "cof",
  "coreId" : "coreId"
}
  • */*
Responses
200
OK
publicKey (optional)
String
privateKey (optional)
String
senderId (optional)
String
login (optional)
String
password (optional)
String
secureLevel (optional)
String
alias (optional)
String
merchantName (optional)
String
merchantAddress (optional)
String
paymentTypes (optional)
supports (optional)
array[String]
type (optional)
String
allowCustomerTypes (optional)
String
googleMerchantId (optional)
String
allowCreditTransaction (optional)
Boolean
3ds (optional)
Boolean
availablePaymentTypes (optional)
array[String]
cof (optional)
String
validateBasket (optional)
String
captchaFeatureEnable (optional)
String
coreId (optional)
String
isAllowedPaypalOT (optional)
String
enableMandatory3dsEmail (optional)
String
enableCrossChannelReferencing (optional)
String

post /v1/keypair/applepay/certificates

(registerAppleCertification)
Uploads your Apple Pay certificate to Unzer.
  • application/json
Request body
DigitalWalletPayCertification
format
String
certificate
String
type
String
privateMinuskey
String
(required)
Body Parameter
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
201
Created
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

post /v1/keypair/applepay/privatekeys

(registerApplePrivateKey)
Uploads your Apple Pay's private-key to Unzer.
  • application/json
Request body
DigitalWalletPayPrivateKeyRequest
format
String
certificate
String
type
String
(required)
Body Parameter
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
201
Created
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

post /v1/keypair/googlepay/certificates

(registerGoogleCertification)
Uploads your Google Pay certificate to Unzer.
  • application/json
Request body
DigitalWalletPayCertification
format
String
certificate
String
type
String
privateMinuskey
String
(required)
Body Parameter
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
201
Created
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

post /v1/keypair/googlepay/privatekeys

(registerGooglePrivateKey)
Uploads your Google Pay's private-key to Unzer.
  • application/json
Request body
DigitalWalletPayPrivateKeyRequest
format
String
certificate
String
type
String
(required)
Body Parameter
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
201
Created
id
String
format (optional)
String
type (optional)
String
certificate (optional)
String
paymentType (optional)
String
active (optional)
Boolean
privateMinuskey (optional)
String

Merchant Payment Page

get /v1/paypage/{id}

(get4)
Fetch the created paymenresource.
Path parameters
id (required)
Path Parameter — The releated payment page id. default: null
{
  "css" : {
    "key" : "css"
  },
  "redirectUrl" : "redirectUrl",
  "impressumUrl" : "impressumUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "card3ds" : "{}",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
200
OK
id (optional)
String
redirectUrl (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
paymentReference (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
Object
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
array[String]

post /v1/paypage/authorize/

(registerAuthorizationAction11)
The initialize payment page call with authorize purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel
amount
String
currency
String
returnUrl
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
excludeTypes (optional)
array[String]
paymentReference (optional)
String
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "redirectUrl" : "redirectUrl",
  "impressumUrl" : "impressumUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "card3ds" : "{}",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
paymentReference (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
Object
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
array[String]

post /v1/paypage/authorize

(registerAuthorizationAction2)
The initialize payment page call with authorize purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel
amount
String
currency
String
returnUrl
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
excludeTypes (optional)
array[String]
paymentReference (optional)
String
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "redirectUrl" : "redirectUrl",
  "impressumUrl" : "impressumUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "card3ds" : "{}",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
paymentReference (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
Object
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
array[String]

post /v1/paypage/charge/

(registerChargeAction11)
The initialize payment page call with direct charge purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel
amount
String
currency
String
returnUrl
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
excludeTypes (optional)
array[String]
paymentReference (optional)
String
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "redirectUrl" : "redirectUrl",
  "impressumUrl" : "impressumUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "card3ds" : "{}",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
paymentReference (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
Object
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
array[String]

post /v1/paypage/charge

(registerChargeAction2)
The initialize payment page call with direct charge purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel
amount
String
currency
String
returnUrl
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
shopDescription (optional)
String
tagline (optional)
String
stepline (optional)
String
header (optional)
String
shopName (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
orderId (optional)
String
backToMerchantLink (optional)
String
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
String
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
excludeTypes (optional)
array[String]
paymentReference (optional)
String
(required)
Body Parameter
{
  "css" : {
    "key" : "css"
  },
  "redirectUrl" : "redirectUrl",
  "impressumUrl" : "impressumUrl",
  "orderId" : "orderId",
  "shopName" : "shopName",
  "action" : "CHARGE",
  "currency" : "currency",
  "id" : "id",
  "imprintUrl" : "imprintUrl",
  "returnUrl" : "returnUrl",
  "shippingAddressRequired" : "shippingAddressRequired",
  "amount" : "amount",
  "billingAddressRequired" : "billingAddressRequired",
  "excludeTypes" : [ "excludeTypes", "excludeTypes" ],
  "paymentReference" : "paymentReference",
  "termsAndConditionUrl" : "termsAndConditionUrl",
  "helpUrl" : "helpUrl",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "privacyPolicyUrl" : "privacyPolicyUrl",
  "card3ds" : "{}",
  "logoImage" : "logoImage",
  "shopDescription" : "shopDescription",
  "fullPageImage" : "fullPageImage",
  "tagline" : "tagline",
  "contactUrl" : "contactUrl",
  "invoiceId" : "invoiceId",
  "additionalAttributes" : {
    "key" : "additionalAttributes"
  }
}
  • */*
Responses
201
Created
id (optional)
String
redirectUrl (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
logoImage (optional)
String
fullPageImage (optional)
String
shopName (optional)
String
shopDescription (optional)
String
tagline (optional)
String
css (optional)
map[String, String]
orderId (optional)
String
termsAndConditionUrl (optional)
String
privacyPolicyUrl (optional)
String
paymentReference (optional)
String
impressumUrl (optional)
String
imprintUrl (optional)
String
helpUrl (optional)
String
contactUrl (optional)
String
invoiceId (optional)
String
card3ds (optional)
Object
billingAddressRequired (optional)
String
shippingAddressRequired (optional)
String
additionalAttributes (optional)
map[String, String]
resources (optional)
customerId (optional)
String
basketId (optional)
String
metadataId (optional)
String
action (optional)
String
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
array[String]

Metadata

post /v1/metadata

(createMetadata1)
Create the metadata resource.
  • application/json
Request body
inline_object_1
shop_id (optional)
String
shop_code (optional)
String
invoice_number (optional)
String
(required)
Body Parameter
{
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String

get /v1/metadata/{id}

(getMetadata)
Fetch the metadata resource.
Path parameters
id (required)
Path Parameter — The releated metadata identity (E.g: s-mtd-1). default: null
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK

put /v1/metadata/{id}

(updateMetadata)
Update the metadata resource.
Path parameters
id (required)
Path Parameter — The releated metadata identity (E.g: s-mtd-1). default: null
  • application/json
Request body
inline_object
shop_id (optional)
String
shop_code (optional)
String
invoice_number (optional)
String
(required)
Body Parameter
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK

Payment

post /v1/payments/authorize

(authorize1)
Reserves the specified amount using the specified payment type <typeId>. This reserved amount can be charged later.
  • application/json
  • !application/json
Request body
PaymentRequest
amount
String
Amount in possitive decimal values. Accepted length: Decimal{10,4}.
currency
String
Currency in ISO Alpha 3 notation.
returnUrl (optional)
String
URL to redirect the customer after the payment is completed (in case of redirect payments e.g. Paypal, Sofort). Required in condition.
card3ds (optional)
Boolean
Only valid for Card method: Overrides the existing credit card configuration if possible.
paymentReference (optional)
String
Transaction description
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
resources
customerId (optional)
String
The id of the Customer resource to be used. We accept the merchant's customerCode.
typeId
String
The id of the Payment types resource to be used.
metadataId (optional)
String
The id of the Metadata resource to be used.
basketId (optional)
String
The id of the Basket resource to be used.
(required)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/charges/{txnCode}/cancels

(cancelChargeTransactionByPayment1)
Cancel the charge transaction which has id = and belongs to the payment with code/OrderId = <codeOrOrderId>.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txnCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
  • application/json
  • !application/json
Request body
CancelModel
amount (optional)
String
paymentReference (optional)
String
reasonCode (optional)
String
amountGross (optional)
String
amountNet (optional)
String
amountVat (optional)
String
canceledBasket (optional)
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/charges/cancels

(cancelTheFirstCharge1)
Cancel the charge transaction which has id = and belongs to the payment with code/OrderId = <codeOrOrderId>.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
  • application/json
  • !application/json
Request body
CancelModel
amount (optional)
String
paymentReference (optional)
String
reasonCode (optional)
String
amountGross (optional)
String
amountNet (optional)
String
amountVat (optional)
String
canceledBasket (optional)
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/charges

(captureOrPayPageCheckout1)
Charges the specified amount from a previous reservation. The charge amount could not exceed the reserved amount.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
  • application/json
  • !application/json
Request body
CaptureModel
amount (optional)
String
Amount in decimal values (e.g. EUR 12.20). If not provide, charge full amount of authorization.
orderId (optional)
String
Order id that is assigned to the payment on merchant side.
invoiceId (optional)
String
Invoice id that is assigned to the payment on merchant side. Max-length = 256
paymentReference (optional)
String
The transaction description.
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/charges

(charge1)
Charges the specified amount using the specified payment type <typeId>.
  • application/json
  • !application/json
Request body
PaymentRequest
amount
String
Amount in possitive decimal values. Accepted length: Decimal{10,4}.
currency
String
Currency in ISO Alpha 3 notation.
returnUrl (optional)
String
URL to redirect the customer after the payment is completed (in case of redirect payments e.g. Paypal, Sofort). Required in condition.
card3ds (optional)
Boolean
Only valid for Card method: Overrides the existing credit card configuration if possible.
paymentReference (optional)
String
Transaction description
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
resources
customerId (optional)
String
The id of the Customer resource to be used. We accept the merchant's customerCode.
typeId
String
The id of the Payment types resource to be used.
metadataId (optional)
String
The id of the Metadata resource to be used.
basketId (optional)
String
The id of the Basket resource to be used.
(required)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/cancels/{cancelCode}

(getARefundForFirstCharge)
Fetch the corresponding canceled transaction for the 1st charge.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
cancelCode (required)
Path Parameter — The related transaction identity (E.g: s-cnl-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/authorize

(getAuthorizeOnlyWithPaymentCode)
Fetch the first corresponding authorized transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/authorize/{txnCode}

(getAuthorizeTransactionByPayment)
Fetch the corresponding authorized transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txnCode (required)
Path Parameter — The related transaction identity (E.g: s-aut-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/authorize

(getAuthorizeTransactionByUuid)
Returns details information of an authorization resource.
Query parameters
id (optional)
Query Parameter — default: null format: int64
uniqueId (optional)
Query Parameter — default: null
orderId (optional)
Query Parameter — default: null
shortId (optional)
Query Parameter — default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/charges/{anyId}

(getCharge)
Returns detail information of a charge.
Path parameters
anyId (required)
Path Parameter — Any possible ids. This id can be payment-id or transaction's uuid/shortid default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/{txnCode}

(getChargeTransactionByPayment)
Fetch the corresponding charged transaction. The first found charged transaction will be returned if the <txnCode> = null.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txnCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/chargebacks/{chargeBackCode}

(getChargebackOfTheFirstCharge)
Fetch the corresponding chargeback transaction for the 1st charge.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
chargeBackCode (required)
Path Parameter — The related transaction identity (E.g: s-cbk-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/{chargeCode}/chargebacks/{chargeBackCode}

(getChargebackTransactionByPayment)
Fetch the corresponding chargeback transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
chargeCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
chargeBackCode (required)
Path Parameter — The related transaction identity (E.g: s-cbk-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/{chargeCode}/chargebacks

(getFirstChargeback)
Fetch the 1st chargeback transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
chargeCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/{chargeCode}/cancels

(getFirstRefundOfACharge)
Fetch the first canceled transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
chargeCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/authorize/{authCode}/cancels

(getFirstReversalTxnOfAnAut)
Fetch the first canceled transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
authCode (required)
Path Parameter — The related transaction identity (E.g: s-aut-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}

(getPayment)
Fetch the payment resource. Provides an overview about a payment.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
{
  "card3ds" : "card3ds",
  "amount" : {
    "canceled" : 5.962134,
    "total" : 6.0274563,
    "charged" : 1.4658129,
    "remaining" : 5.637377
  },
  "orderId" : "orderId",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "state" : {
    "name" : "name",
    "id" : 0
  },
  "transactions" : [ {
    "participantId" : "participantId",
    "date" : "date",
    "amount" : "amount",
    "type" : "type",
    "url" : "url",
    "status" : "status"
  }, {
    "participantId" : "participantId",
    "date" : "date",
    "amount" : "amount",
    "type" : "type",
    "url" : "url",
    "status" : "status"
  } ]
}
  • */*
Responses
200
OK
id (optional)
String
The id of payment (ex: s-pay-1).
state (optional)
id (optional)
Integer
format: int32
name (optional)
String
amount (optional)
total (optional)
Float
Initial amount reduced by cancellations during authorization format: float
charged (optional)
Float
Already charged amount format: float
canceled (optional)
Float
Refunded amount of all charges format: float
remaining (optional)
Float
Difference between total and charged format: float
currency (optional)
String
orderId (optional)
String
Order id of the merchant application. This id can also be used to get payments from the api. The id has to be unique for the used key pair.
invoiceId (optional)
String
InvoiceId of the merchant.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
transactions (optional)
List of subsequence transaction(s).
participantId (optional)
String
date (optional)
String
type (optional)
String
status (optional)
String
url (optional)
String
amount (optional)
String
card3ds (optional)
String

get /v1/payments/payouts/{anyId}

(getPayout)
Fetch the first corresponding payout transaction by using any ids. This id can be payment-id or transaction's uuid/shortid
Path parameters
anyId (required)
Path Parameter — Any possible ids. This id can be payment-id or transaction's uuid/shortid default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/payouts/{txnCode}

(getPayoutTransactionByPayment)
Fetch the corresponding payout transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txnCode (required)
Path Parameter — default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges/{chargeCode}/cancels/{cancelCode}

(getRefundTransactionByPayment)
Fetch the corresponding canceled transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
chargeCode (required)
Path Parameter — The related transaction identity (E.g: s-chg-1) default: null
cancelCode (required)
Path Parameter — The related transaction identity (E.g: s-cnl-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/authorize/{authCode}/cancels/{cancelCode}

(getReversalTransactionByPayment)
Fetch the corresponding canceled transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
authCode (required)
Path Parameter — The related transaction identity (E.g: s-aut-1) default: null
cancelCode (required)
Path Parameter — The related transaction identity (E.g: s-cnl-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/shipments/{txncode}

(getShipmentPayment)
Fetch the corresponding shipment transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txncode (required)
Path Parameter — The related transaction identity (E.g: s-shp-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/charges

(getTheFirstCharge)
Fetch the first found charged transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/payouts

(getTheFirstPayoutTxn)
Fetch the first payout transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/shipments

(getTheFirstShipment)
Fetch the first corresponding shipment transaction.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

get /v1/payments/{codeOrOrderId}/authorize/cancels/{cancelCode}

(getTheReversalTxnOfTheFirstAut)
Fetch the corresponding canceled transaction. The first found canceled transaction will be returned if the <cancelCode> = null.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
cancelCode (required)
Path Parameter — The related transaction identity (E.g: s-cnl-1) default: null
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
200
OK
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/authorize/{txnCode}/cancels

(multipartCancelAuthorizeTransactionByPayment1)
Cancels an existing authorization. The reserved money on the customers payment method will be freed up.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
txnCode (required)
Path Parameter — The related transaction identity (E.g: s-aut-1). default: null
  • !application/json
  • application/json
Request body
CancelModel
amount (optional)
String
paymentReference (optional)
String
reasonCode (optional)
String
amountGross (optional)
String
amountNet (optional)
String
amountVat (optional)
String
canceledBasket (optional)
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/authorize/cancels

(multipartCancelTheFirstFoundAut1)
Cancels an existing authorization. The reserved money on the customers payment method will be freed up.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
  • !application/json
  • application/json
Request body
CancelModel
amount (optional)
String
paymentReference (optional)
String
reasonCode (optional)
String
amountGross (optional)
String
amountNet (optional)
String
amountVat (optional)
String
canceledBasket (optional)
amountTotalDiscount
String
Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
String
timestamp (optional)
String
items (optional)
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String
Unique basket item reference ID (within the basket)
unit (optional)
String
Unit description of the item e.g. "pc" (Only in response).
quantity
String
Quantity of the basket item.
amountDiscount (optional)
Float
Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer
Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float
Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float
Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float
NET amount per unit (Only in response). format: float
amountNet (optional)
Float
Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String
Title of the basket item (max. 255)
subTitle (optional)
String
The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String
The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String
Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/payouts

(payout1)
Call payout with the specified amount to the customer account which is specified on payment type <typeId>.
  • application/json
  • !application/json
Request body
PaymentRequest
amount
String
Amount in possitive decimal values. Accepted length: Decimal{10,4}.
currency
String
Currency in ISO Alpha 3 notation.
returnUrl (optional)
String
URL to redirect the customer after the payment is completed (in case of redirect payments e.g. Paypal, Sofort). Required in condition.
card3ds (optional)
Boolean
Only valid for Card method: Overrides the existing credit card configuration if possible.
paymentReference (optional)
String
Transaction description
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
resources
customerId (optional)
String
The id of the Customer resource to be used. We accept the merchant's customerCode.
typeId
String
The id of the Payment types resource to be used.
metadataId (optional)
String
The id of the Metadata resource to be used.
basketId (optional)
String
The id of the Basket resource to be used.
(required)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/payments/{codeOrOrderId}/shipments

(shipPayment1)
Ship the payment with the specified amount for the payment. The amount cannot exceed the total amount.
Path parameters
codeOrOrderId (required)
Path Parameter — The related payment identity. This can be the paymentCode or Id. default: null
  • application/json
  • !application/json
Request body
ShipmentModel
amount (optional)
String
orderId (optional)
String
invoiceId (optional)
String
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : 0.8008282,
  "redirectUrl" : "redirectUrl",
  "orderId" : "orderId",
  "paymentReference" : "paymentReference",
  "resources" : {
    "basketId" : "basketId",
    "metadataId" : "metadataId",
    "paymentId" : "paymentId",
    "customerId" : "customerId",
    "linkPayId" : "linkPayId",
    "typeId" : "typeId",
    "payPageId" : "payPageId"
  },
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "card3ds" : true,
  "isError" : true,
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "invoiceId" : "invoiceId",
  "id" : "id",
  "returnUrl" : "returnUrl",
  "effectiveInterestRate" : "effectiveInterestRate",
  "isSuccess" : true
}
  • */*
Responses
201
Created
id (optional)
String
Id of this charge transaction
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
card3ds (optional)
Boolean
Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String
Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
Float
The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String
Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String
ISO currency code. You can find a list of all codes on the Amounts and Currencies overview page.
returnUrl (optional)
String
If customer's confirmation is required, a redirect URL will be return. Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String
Timestamp of this transaction.
resources (optional)
customerId (optional)
String
Customer id used for this transaction.
paymentId (optional)
String
Id of the payment.
basketId (optional)
String
Basket ID used for this transaction.
metadataId (optional)
String
Meta data ID used for this transaction.
payPageId (optional)
String
Payment Page Id related to this payment.
linkPayId (optional)
String
typeId (optional)
String
Id of the types Resource that is to be used for this transaction.
orderId (optional)
String
Order id that identifies the payment on merchant side.
invoiceId (optional)
String
invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String
Transaction description.
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

PayPal

post /v1/types/paypal

(createPaypal1)
Create Paypal payment method resource.
  • application/json
  • application/x-www-form-urlencoded
Request body
Paypal
email (optional)
String
amount (optional)
String
currency (optional)
String
basketId (optional)
String
customerId (optional)
String
(optional)
Body Parameter
{
  "method" : "method",
  "connector" : "connector",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "email" : "email"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
email (optional)
String
connector (optional)
String

get /v1/types/paypal/{id}

(getPaypalPaymentMethodResource)
Retrieve an existed Paypal payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/paypal default: null
{
  "method" : "method",
  "connector" : "connector",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
email (optional)
String
connector (optional)
String

put /v1/types/paypal/{id}

(updatePaypalPaymentMethodResource1)
Update Paypal payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/paypal default: null
  • application/json
  • !application/json
Request body
Paypal
email (optional)
String
amount (optional)
String
currency (optional)
String
basketId (optional)
String
customerId (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "connector" : "connector",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "email" : "email"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
email (optional)
String
connector (optional)
String

Post Finance Card

post /v1/types/post-finance-card

(createWithoutCustomerInfo12)
Create Post-Finance-Card payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/post-finance-card/{id}

(getPFCardPaymentMethodResource)
Retrieve an existed Post-Finance-Card payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/post-finance-card default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Post Finance Efinance

post /v1/types/post-finance-efinance

(createWithoutCustomerInfo13)
Create Post-Finance-eFinance payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/post-finance-efinance/{id}

(getPFEFinancePaymentMethodResource)
Retrieve an existed Post-Finance-eFinance payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/post-finance-efinance default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

PIS

post /v1/types/pis

(createFlexipay1)
Create PIS payment method resource.
  • application/json
  • !application/json
Request body
PIS
bic (optional)
String
iban (optional)
String
holder (optional)
String
(optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

get /v1/types/pis/{id}

(getPISPaymentMethodResource)
Retrieve an existed PIS payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/pis default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

PrePayment

post /v1/types/prepayment

(createWithoutCustomerInfo11)
Create Prepayment payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/prepayment/{id}

(getPrePaymentPaymentMethodResource)
Retrieve an existed Prepayment payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/prepayment default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String


Przelewy24

post /v1/types/przelewy24

(createWithoutCustomerInfo10)
Create Przelewy24 payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/przelewy24/{id}

(getPrzelewy24PaymentMethodResource)
Retrieve an existed Przelewy24 payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/przelewy24 default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Recurring

get /v1/types/{methodId}/recurring

(getRecurring)
Fetch the recurring status of the provided method.
Path parameters
methodId (required)
Path Parameter — The releated payment method identity (E.g: s-crd-1). default: null
{
  "date" : "date",
  "amount" : "amount",
  "isError" : true,
  "redirectUrl" : "redirectUrl",
  "resources" : {
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "returnUrl" : "returnUrl",
  "isSuccess" : true
}
  • */*
Responses
200
OK
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
redirectUrl (optional)
String
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
date (optional)
String
resources (optional)
customerId (optional)
String
metadataId (optional)
String
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

post /v1/types/recurring

(multiPartRegisterRecurringByUuid1)
Create the new recurring payment type by using the transaction's UUID.
  • !application/json
  • application/json
Request body
RecurringRegistrationRequest
uuid
String
(optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

post /v1/types/{methodId}/recurring

(registerRecurring1)
Register recurring for the using payment method. The provided method will not asking for customer's activities for later checkout.
Path parameters
methodId (required)
Path Parameter — The releated payment method identity (E.g: s-crd-1). default: null
  • application/json
  • !application/json
Request body
RecurringRequest
amount (optional)
String
returnUrl (optional)
String
currency (optional)
String
resources (optional)
customerId (optional)
String
metadataId (optional)
String
(optional)
Body Parameter
{
  "date" : "date",
  "amount" : "amount",
  "isError" : true,
  "redirectUrl" : "redirectUrl",
  "resources" : {
    "metadataId" : "metadataId",
    "customerId" : "customerId"
  },
  "processing" : {
    "traceId" : "traceId",
    "basketId" : "basketId",
    "shortId" : "shortId",
    "zgReferenceId" : "zgReferenceId",
    "creatorId" : "creatorId",
    "holder" : "holder",
    "externalOrderId" : "externalOrderId",
    "descriptor" : "descriptor",
    "participantId" : "participantId",
    "identification" : "identification",
    "3dsEci" : "3dsEci",
    "PDFLink" : "PDFLink",
    "iban" : "iban",
    "bic" : "bic",
    "uniqueId" : "uniqueId",
    "paypalBuyerId" : "paypalBuyerId"
  },
  "currency" : "currency",
  "isPending" : true,
  "message" : {
    "code" : "code",
    "merchant" : "merchant",
    "customer" : "customer"
  },
  "returnUrl" : "returnUrl",
  "isSuccess" : true
}
  • */*
Responses
201
Created
isSuccess (optional)
Boolean
isPending (optional)
Boolean
isError (optional)
Boolean
redirectUrl (optional)
String
message (optional)
code (optional)
String
merchant (optional)
String
customer (optional)
String
amount (optional)
String
currency (optional)
String
returnUrl (optional)
String
date (optional)
String
resources (optional)
customerId (optional)
String
metadataId (optional)
String
processing (optional)
creatorId (optional)
String
This value returns your creditor id.
identification (optional)
String
This value returns the descriptor for invoice and prepayment.
iban (optional)
String
Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String
Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String
External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String
Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
String
basketId (optional)
String
Basket ID used for this transaction.
uniqueId (optional)
String
Unique id of the payment system used.
shortId (optional)
String
User-friendly reference id of the payment system.
descriptor (optional)
String
Descriptor of the merchant for prepayment or invoice.
holder (optional)
String
Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String
PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String
Id of buyer for Paypal transaction.
3dsEci (optional)
String
3dsEci flag from Payment Core.
participantId
String
Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).

Sepa Direct Debit

post /v1/types/sepa-direct-debit

(createWithoutCustomerInfo2)
Create Sepa-Direct-Debit payment method resource.
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

get /v1/types/sepa-direct-debit/{id}

(getSepaDirectDebitPaymentMethodResource)
Retrieve an existed Sepa-Direct-Debit payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

put /v1/types/sepa-direct-debit/{id}

(updateSepaDirectDebitPaymentMethodResource1)
Update Sepa-Direct-Debit payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit default: null
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

Sepa DirectDebit Guaranteed

post /v1/types/sepa-direct-debit-guaranteed

(createWithoutCustomerInfo3)
Create Sepa-Direct-Debit-Guaranteed payment method resource.
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

get /v1/types/sepa-direct-debit-guaranteed/{id}

(getCardPaymentMethodResource3)
Retrieve an existed Sepa-Direct-Debit-Guaranteed payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit-guaranteed default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

put /v1/types/sepa-direct-debit-guaranteed/{id}

(updatePaymentMethodResource1)
Update Sepa-Direct-Debit-Guaranteed payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit-guaranteed default: null
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

Sepa Direct Debit Secured

post /v1/types/sepa-direct-debit-secured

(createWithoutCustomerInfo4)
Create Sepa-Direct-Debit-Secured payment method resource.
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

get /v1/types/sepa-direct-debit-secured/{id}

(getCardPaymentMethodResource4)
Retrieve an existed Sepa-Direct-Debit-Secured payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit-secured default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

put /v1/types/sepa-direct-debit-secured/{id}

(updatePaymentMethodResource2)
Update Sepa-Direct-Debit-Secured payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sepa-direct-debit-secured default: null
  • application/json
  • !application/json
Request body
SepaDirectDebit
iban (optional)
String
bic (optional)
String
holder (optional)
String
(required)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String
iban (optional)
String
bic (optional)
String
holder (optional)
String

Simualation Async

get /v1/simulation/alipay/{uuid}

(alipay)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/bancontact/{uuid}

(bancontact)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/card/{uuid}

(card)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/eps/{uuid}

(eps)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/giropay/{uuid}

(giropay)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/ideal/{uuid}

(ideal)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/paypal/{uuid}

(paypal)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/pis/{uuid}

(pis)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/przelewy24/{uuid}

(przelewy24)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/sofort/{uuid}

(sofort)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

get /v1/simulation/wechatpay/{uuid}

(wechatpay)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK Boolean

Sofort

post /v1/types/sofort

(createWithoutCustomerInfo)
Create Sofort payment method resource.
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/sofort/{id}

(getSofortPaymentMethodResource)
Retrieve an existed Sofort payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/sofort default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

WeChat Pay

post /v1/types/wechatpay

(createWithoutCustomerInfo151)
Create WechatPay payment method resource.
  • application/json
  • !application/json
Request body
body object (optional)
Body Parameter
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

get /v1/types/wechatpay/{id}

(getWeChatPayPaymentMethodResource)
Retrieve an existed WechatPay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/wechatpay default: null
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK
id (optional)
String
method (optional)
String
recurring (optional)
Boolean
customerId (optional)
String
geoLocation (optional)
clientIp (optional)
String
countryIsoA2 (optional)
String

Webhook Registration

delete /v1/webhooks

(deleteAll)
Delete all webhooks resources which belong to the key
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK

delete /v1/webhooks/{eventId}

(deleteWebhook)
Delete a webhook resource
Path parameters
eventId (required)
Path Parameter — Describe the webhook eventId which will be queried from server default: null
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK
id (optional)
String
url (optional)
String
event (optional)
String

get /v1/webhooks/{eventId}

(get1)
Get one specific webhook resource which belongs to the
Path parameters
eventId (required)
Path Parameter — Describe the webhook eventId which will be queried from server default: null
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK
id (optional)
String
url (optional)
String
event (optional)
String

get /v1/webhooks

(getAll)
Get all webhook resources belong to the key
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
200
OK

post /v1/webhooks

(registerMultipart1)
Create a new webhook
  • application/x-www-form-urlencoded
  • application/json
Form parameters
url (optional)
Form Parameter — default: null
event (optional)
Form Parameter — default: null
eventList (optional)
Form Parameter — default: null
This API call produces the following media types according to the request header; the media type will be conveyed by the
  • */*
Responses
201
Created String

put /v1/webhooks/{eventId}

(updateJson1)
Update webhook url by
Path parameters
eventId (required)
Path Parameter — Describe the webhook eventId which will be queried from server default: null
  • application/json
  • !application/json
Request body
WebhookRegistrationModel
url (optional)
String
event (optional)
String
eventList (optional)
array[String]
(required)
Body Parameter
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK
id (optional)
String
url (optional)
String
event (optional)
String