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.
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created AliPayResponseModel

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK AliPayResponseModel

Apple Pay

post /v1/types/applepay

(createWithoutCustomerInfo113)
Create ApplePay payment method resource.
  • application/json
  • !application/json
Request body
ApplePayPaymentData ApplePayPaymentData (required)
Body Parameter
Return type
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
201
Created ApplePayResponseModel

post /v1/types/applepay/

(createWithoutCustomerInfo121)
Create ApplePay payment method resource.
  • application/json
  • !application/json
Request body
ApplePayPaymentData ApplePayPaymentData (required)
Body Parameter
Return type
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
201
Created ApplePayResponseModel

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
Return type
{
  "method" : "method",
  "applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "transactionAmount" : "transactionAmount",
  "customerId" : "customerId",
  "id" : "id",
  "currencyCode" : "currencyCode",
  "applicationExpirationDate" : "applicationExpirationDate"
}
  • */*
Responses
200
OK ApplePayResponseModel

Bancontact

post /v1/types/bancontact

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id"
}
  • */*
Responses
200
OK BancontactResponseModel

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 Bancontact (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id"
}
  • */*
Responses
200
OK BancontactResponseModel

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
Return type
{
  "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 BasketModelV1

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
Return type
{
  "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 BasketModelV1

post /v1/baskets/

(registerBasket11)
Create basket resource api
  • application/json
  • !application/json
Request body
BasketModelV1 BasketModelV1 (required)
Body Parameter
Return type
{
  "id" : "id"
}
  • */*
Responses
201
Created BasketResponseModelV1

post /v1/baskets

(registerBasket2)
Create basket resource api
  • application/json
  • !application/json
Request body
BasketModelV1 BasketModelV1 (required)
Body Parameter
Return type
{
  "id" : "id"
}
  • */*
Responses
201
Created BasketResponseModelV1

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 BasketModelV1 (required)
Body Parameter
Return type
{
  "id" : "id"
}
  • */*
Responses
200
OK BasketResponseModelV1

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 BasketModelV1 (required)
Body Parameter
Return type
{
  "id" : "id"
}
  • */*
Responses
200
OK BasketResponseModelV1

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 RedirectView

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 RedirectView

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 Creditcard (required)
Body Parameter
Return type
{
  "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 CardResponseModel

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
Return type
{
  "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 CardResponseModel

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 UpdatedCreditcard (required)
Body Parameter
Return type
{
  "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 CardResponseModel

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 UpdatedEmailCreditcard (optional)
Body Parameter
Return type
{
  "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 CardResponseModel

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
Return type
{
  "id" : "id"
}
  • */*
Responses
200
OK IdResponse

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
Return type
{
  "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 CustomerModel

post /v1/customers

(multipartCreate1)
Store customer data to be used in authorize or charges calls
  • !application/json
  • application/json
Request body
CustomerModel CustomerModel (required)
Body Parameter
Return type
{
  "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 CustomerModel

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 CustomerModel (optional)
Body Parameter
Return type
{
  "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 CustomerModel

Eps

post /v1/types/eps

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK EpsResponseModel

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 Eps (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK EpsResponseModel

GiroPay

post /v1/types/giropay

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK GiroPayResponseModel

Google Pay

post /v1/types/googlepay

(createWithoutCustomerInfo114)
Create GooglePay payment method resource.
  • application/json
  • !application/json
Request body
GooglePayPaymentData GooglePayPaymentData (required)
Body Parameter
Return type
{
  "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 GooglePayResponseModel

post /v1/types/googlepay/

(createWithoutCustomerInfo122)
Create GooglePay payment method resource.
  • application/json
  • !application/json
Request body
GooglePayPaymentData GooglePayPaymentData (required)
Body Parameter
Return type
{
  "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 GooglePayResponseModel

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
Return type
{
  "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 GooglePayResponseModel

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
Return type
{
  "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 GooglePayResponseModel

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
Return type
{
  "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 HirePurchaseDDResponseModel

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
Return type
{
  "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 RetrieveResponse

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

(multipartCreateWithoutCustomerInfo1)
Create Hire-Purchase payment method resource.
  • !application/json
  • application/json
Request body
HirePurchaseDD HirePurchaseDD (required)
Body Parameter
Return type
{
  "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 HirePurchaseDDResponseModel

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 HirePurchaseDDUpdateRequest (required)
Body Parameter
Return type
{
  "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 HirePurchaseDDResponseModel

Ideal

post /v1/types/ideal

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK IdealResponseModel

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 Ideal (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK IdealResponseModel

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
Return type
{
  "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 InstallmentSecuredResponseModel

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
Return type
{
  "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 RetrieveResponse

post /v1/types/installment-secured

(multipartCreateWithoutCustomerInfo2)
Create Installment-Secured payment method resource.
  • !application/json
  • application/json
Request body
InstallmentSecured InstallmentSecured (required)
Body Parameter
Return type
{
  "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 InstallmentSecuredResponseModel

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 InstallmentSecuredUpdateRequest (required)
Body Parameter
Return type
{
  "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 InstallmentSecuredResponseModel

Invoice

post /v1/types/invoice

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK InvoiceResponseModel

Invoice Factoring

post /v1/types/invoice-factoring

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK InvoiceFactoringResponseModel

Invoice Guaranteed

post /v1/types/invoice-guaranteed

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK InvoiceGuaranteedResponseModel

Invoice Secured

post /v1/types/invoice-secured

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK InvoiceSecuredResponseModel

LinkPay

post /v1/linkpay/{aliasOrId}/authorize

(authorizeLinkPayPage1)
Path parameters
aliasOrId (required)
Path Parameter — default: null
  • application/json
  • !application/json
Request body
LinkPayModel LinkPayModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

post /v1/linkpay/{aliasOrId}/charge

(chargeLinkPayPage1)
Path parameters
aliasOrId (required)
Path Parameter — default: null
  • application/json
  • !application/json
Request body
LinkPayModel LinkPayModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 LinkPayResponse

post /v1/linkpay/charge/

(initCharge11)
  • application/json
  • !application/json
Request body
LinkPayRequest LinkPayRequest (required)
Body Parameter
Return type
{
  "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 LinkPayResponse

post /v1/linkpay/charge

(initCharge2)
  • application/json
  • !application/json
Request body
LinkPayRequest LinkPayRequest (required)
Body Parameter
Return type
{
  "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 LinkPayResponse

post /v1/linkpay/authorize/

(multipartInitAuthorize11)
  • !application/json
  • application/json
Request body
LinkPayRequest LinkPayRequest (required)
Body Parameter
Return type
{
  "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 LinkPayResponse

post /v1/linkpay/authorize

(multipartInitAuthorize2)
  • !application/json
  • application/json
Request body
LinkPayRequest LinkPayRequest (required)
Body Parameter
Return type
{
  "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 LinkPayResponse

put /v1/linkpay/{id}

(multipartUpdate1)
Path parameters
id (required)
Path Parameter — default: null
  • !application/json
  • application/json
Request body
LinkPayUpdateRequest LinkPayUpdateRequest (required)
Body Parameter
Return type
{
  "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 LinkPayResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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.
Return type
{
  "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 KeyPairResponse

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.
Return type
{
  "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 KeyPairResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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
Return type
{
  "private-key" : "private-key",
  "format" : "format",
  "certificate" : "certificate",
  "active" : true,
  "id" : "id",
  "type" : "type",
  "paymentType" : "paymentType"
}
  • */*
Responses
200
OK DigitalWalletPayCertificationResponse

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.
Return type
{
  "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 KeyPairResponse

post /v1/keypair/applepay/certificates

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

post /v1/keypair/applepay/privatekeys

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

post /v1/keypair/googlepay/certificates

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

post /v1/keypair/googlepay/privatekeys

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

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
Return type
{
  "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 PaymentPageResponseModel

post /v1/paypage/authorize/

(registerAuthorizationAction11)
The initialize payment page call with authorize purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel PaymentPageModel (required)
Body Parameter
Return type
{
  "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 PaymentPageResponseModel

post /v1/paypage/authorize

(registerAuthorizationAction2)
The initialize payment page call with authorize purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel PaymentPageModel (required)
Body Parameter
Return type
{
  "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 PaymentPageResponseModel

post /v1/paypage/charge/

(registerChargeAction11)
The initialize payment page call with direct charge purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel PaymentPageModel (required)
Body Parameter
Return type
{
  "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 PaymentPageResponseModel

post /v1/paypage/charge

(registerChargeAction2)
The initialize payment page call with direct charge purpose.
  • application/json
  • !application/json
Request body
PaymentPageModel PaymentPageModel (required)
Body Parameter
Return type
{
  "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 PaymentPageResponseModel

Metadata

post /v1/metadata

(createMetadata1)
Create the metadata resource.
  • application/json
Request body
inline_object_1 inline_object_1 (required)
Body Parameter
Return type
{
  "id" : "id"
}
  • */*
Responses
201
Created MetadataResponse

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
Return type
map[String, String]
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 inline_object (required)
Body Parameter
Return type
map[String, String]
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 PaymentRequest (required)
Body Parameter
Return type
{
  "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 PaymentResponse

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 CancelModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

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 CancelModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

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 CaptureModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

post /v1/payments/charges

(charge1)
Charges the specified amount using the specified payment type <typeId>.
  • application/json
  • !application/json
Request body
PaymentRequest PaymentRequest (required)
Body Parameter
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentGetResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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
Return type
{
  "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 PaymentResponse

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 CancelModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

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 CancelModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

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 PaymentRequest (required)
Body Parameter
Return type
{
  "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 PaymentResponse

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 ShipmentModel (optional)
Body Parameter
Return type
{
  "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 PaymentResponse

PayPal

post /v1/types/paypal

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

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
Return type
{
  "method" : "method",
  "connector" : "connector",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "email" : "email"
}
  • */*
Responses
200
OK PaypalResponseModel

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 Paypal (required)
Body Parameter
Return type
{
  "method" : "method",
  "connector" : "connector",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id",
  "email" : "email"
}
  • */*
Responses
200
OK PaypalResponseModel

Post Finance Card

post /v1/types/post-finance-card

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK PFCardResponseModel

Post Finance Efinance

post /v1/types/post-finance-efinance

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK PFEfinanceResponseModel

PIS

post /v1/types/pis

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK PISResponseModel

PrePayment

post /v1/types/prepayment

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK PrePaymentResponseModel


Przelewy24

post /v1/types/przelewy24

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK Przelewy24ResponseModel

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
Return type
{
  "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 RecurringResponse

post /v1/types/recurring

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

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 RecurringRequest (optional)
Body Parameter
Return type
{
  "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 RecurringResponse

Sepa Direct Debit

post /v1/types/sepa-direct-debit

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitResponseModel

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 SepaDirectDebit (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitResponseModel

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 SepaDirectDebit (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created SepaDirectDebitGuaranteedResponseModel

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitGuaranteedResponseModel

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 SepaDirectDebit (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitResponseModel

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 SepaDirectDebit (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
201
Created SepaDirectDebitSecuredResponseModel

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitSecuredResponseModel

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 SepaDirectDebit (required)
Body Parameter
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "iban" : "iban",
  "customerId" : "customerId",
  "holder" : "holder",
  "id" : "id",
  "bic" : "bic"
}
  • */*
Responses
200
OK SepaDirectDebitResponseModel

Simualation Async

get /v1/simulation/alipay/{uuid}

(alipay)
Path parameters
uuid (required)
Path Parameter — default: null
Query parameters
state (optional)
Query Parameter — default: success
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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
Return type
Boolean
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.
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
201
Created SofortResponseModel

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK SofortResponseModel

WeChat Pay

post /v1/types/wechatpay

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

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
Return type
{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}
  • */*
Responses
200
OK WeChatPayResponseModel

Webhook Registration

delete /v1/webhooks

(deleteAll)
Delete all webhooks resources which belong to the key
Return type
map[String, array[WebhookRegistrationResponse]]
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
Return type
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK WebhookRegistrationResponse

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
Return type
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK WebhookRegistrationResponse

get /v1/webhooks

(getAll)
Get all webhook resources belong to the key
Return type
map[String, array[WebhookRegistrationResponse]]
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
Return type
String
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 WebhookRegistrationModel (required)
Body Parameter
Return type
{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}
  • */*
Responses
200
OK WebhookRegistrationResponse

Models

AddressModel

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.

AliPayResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

ApplePayPaymentData

version (optional)
data (optional)
signature (optional)
header (optional)

ApplePayResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
applicationPrimaryAccountNumber (optional)
applicationExpirationDate (optional)
currencyCode (optional)
transactionAmount (optional)

ApplicationContext

displayName (optional)
applicationName (optional)
startupDate (optional)
Long format: int64
autowireCapableBeanFactory (optional)
parent (optional)
id (optional)
environment (optional)
beanDefinitionCount (optional)
Integer format: int32
beanDefinitionNames (optional)
parentBeanFactory (optional)
classLoader (optional)

ApplicationContext_classLoader

parent (optional)
defaultAssertionStatus (optional)

ApplicationContext_classLoader_parent

defaultAssertionStatus (optional)

Bancontact

holder (optional)

BancontactResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
holder (optional)

BasketCancelModelV1

Only valid for marketplace payment: The canceled basket resource.
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)
timestamp (optional)
items (optional)
array[BasketItemCancelModelV1] Only valid for marketplace payment: The canceled basket resource

BasketItemCancelModelV1

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"

BasketItemModelV1

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)

BasketModelV1

id (optional)
amountTotal (optional)
amountTotalGross (optional)
amountTotalDiscount (optional)
amountTotalVat (optional)
currencyCode (optional)
orderId
note (optional)
basketItems (optional)
canceledBasket (optional)
array[BasketCancelModelV1] Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.

CancelModel

amount (optional)
paymentReference (optional)
reasonCode (optional)
amountGross (optional)
amountNet (optional)
amountVat (optional)
canceledBasket (optional)

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.

CardDetailsResponseModel

cardType (optional)
account (optional)
countryIsoA2 (optional)
countryName (optional)
issuerName (optional)
issuerUrl (optional)
issuerPhoneNumber (optional)

CardMetadataResponseModel

uniqueId (optional)
shortId (optional)
traceId (optional)

CardResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
number (optional)
type (optional)
brand (optional)
email (optional)
3ds (optional)
cvc (optional)
expiryDate (optional)
cardHolder (optional)
cardDetails (optional)
processing (optional)

CompanyInfoModel

Only valid for B2B setting
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

Creditcard

number
expiryDate
String format: MM/yyyy
cvc
brand (optional)
email (optional)
3ds (optional)
cardHolder (optional)

CssData

shopDescription (optional)
tagline (optional)
stepline (optional)
header (optional)
shopName (optional)
helpUrl (optional)
contactUrl (optional)
invoiceId (optional)
orderId (optional)
backToMerchantLink (optional)

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)
shippingAddress (optional)
companyInfo (optional)

DigitalWalletPayCertification

format
certificate
type
privateMinuskey

DigitalWalletPayCertificationResponse

id
format (optional)
type (optional)
certificate (optional)
paymentType (optional)
active (optional)
privateMinuskey (optional)

DigitalWalletPayHeader

ephemeralPublicKey (optional)
publicKeyHash (optional)
transactionId (optional)

Environment

activeProfiles (optional)
defaultProfiles (optional)

Eps

bic (optional)

EpsResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
bic (optional)

GeoLocationModel

clientIp (optional)
countryIsoA2 (optional)

GiroPayResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

GooglePayBillingAddress

ephemeralPublicKey (optional)
publicKeyHash (optional)
transactionId (optional)
name (optional)
address1 (optional)
address2 (optional)
address3 (optional)
sortingCode (optional)
postalCode (optional)
countryCode (optional)
locality (optional)
administrativeArea (optional)

GooglePayPaymentData

version (optional)
data (optional)
signature (optional)
header (optional)
apiVersionMinor (optional)
apiVersion (optional)
paymentMethodData (optional)
shippingAddress (optional)

GooglePayPaymentMethodData

description (optional)
tokenizationData (optional)
type (optional)
info (optional)

GooglePayPaymentMethodDataInfo

version (optional)
data (optional)
signature (optional)
header (optional)
cardNetwork (optional)
cardDetails (optional)
billingAddress (optional)

GooglePayResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
applicationPrimaryAccountNumber (optional)
applicationExpirationDate (optional)
currencyCode (optional)
transactionAmount (optional)
messageId (optional)
messageExpiration (optional)
paymentMethod (optional)
expirationYear (optional)
expirationMonth (optional)
pan (optional)
authMethod (optional)
cryptogram (optional)
eciIndicator (optional)

GooglePayShippingAddress

ephemeralPublicKey (optional)
publicKeyHash (optional)
transactionId (optional)
name (optional)
address1 (optional)
address2 (optional)
address3 (optional)
sortingCode (optional)
postalCode (optional)
countryCode (optional)
locality (optional)
administrativeArea (optional)

HirePurchaseDD

iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
numberOfRates
dayOfPurchase
totalPurchaseAmount
totalInterestAmount
totalAmount
effectiveInterestRate
nominalInterestRate
feeFirstRate
feePerRate
monthlyRate
lastRate

HirePurchaseDDResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
numberOfRates (optional)
dayOfPurchase (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
invoiceDate (optional)
invoiceDueDate (optional)

HirePurchaseDDUpdateRequest

iban (optional)
bic (optional)
accountHolder (optional)
invoiceDate (optional)
invoiceDueDate (optional)

IdResponse

id (optional)
String Id of deleted resource

Ideal

bic (optional)

IdealResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
bic (optional)

InstallmentSecured

iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
numberOfRates
dayOfPurchase
totalPurchaseAmount
totalInterestAmount
totalAmount
effectiveInterestRate
nominalInterestRate
feeFirstRate
feePerRate
monthlyRate
lastRate

InstallmentSecuredResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
numberOfRates (optional)
dayOfPurchase (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
invoiceDate (optional)
invoiceDueDate (optional)

InstallmentSecuredUpdateRequest

iban (optional)
bic (optional)
accountHolder (optional)
invoiceDate (optional)
invoiceDueDate (optional)

InvoiceFactoringResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

InvoiceGuaranteedResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

InvoiceResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

InvoiceSecuredResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

KeyPairResponse

publicKey (optional)
privateKey (optional)
senderId (optional)
login (optional)
password (optional)
secureLevel (optional)
alias (optional)
merchantName (optional)
merchantAddress (optional)
paymentTypes (optional)
availablePaymentTypes (optional)
cof (optional)
validateBasket (optional)
captchaFeatureEnable (optional)
coreId (optional)
isAllowedPaypalOT (optional)
enableMandatory3dsEmail (optional)
enableCrossChannelReferencing (optional)

LinkPayModel

version
amount
currency
orderId (optional)
invoiceId (optional)
typeId (optional)
resources (optional)
returnUrl

LinkPayRequest

alias (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
orderId (optional)
invoiceId (optional)
expires (optional)
intention (optional)
paymentReference (optional)
additionalAttributes (optional)
resources (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)

LinkPayResourceModel

customerId (optional)

LinkPayResponse

id (optional)
redirectUrl (optional)
version (optional)
alias (optional)
orderId (optional)
invoiceId (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
expires (optional)
intention (optional)
paymentReference (optional)
additionalAttributes (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)
resources (optional)
action (optional)
Enum:
CHARGE
AUTHORIZE

LinkPayUpdateRequest

amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
orderId (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
expires (optional)
additionalAttributes (optional)
intention (optional)
resources (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)

MetadataResponse

id (optional)

PFCardResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

PFEfinanceResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

PIS

bic (optional)
iban (optional)
holder (optional)

PISResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
holder (optional)

PaymentGetResponse

id (optional)
String The id of payment (ex: s-pay-1).
state (optional)
amount (optional)
currency (optional)
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)
transactions (optional)
array[PaymentGetResponseTransaction] List of subsequence transaction(s).
card3ds (optional)

PaymentGetResponseAmount

Summary of all amounts
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

PaymentGetResponseState

Current state of this payment
pending (0)
completed (1)
canceled (2)
partly (3)
payment review (4)
chargeback
id (optional)
Integer format: int32
name (optional)

PaymentGetResponseTransaction

List of subsequence transaction(s).
participantId (optional)
date (optional)
type (optional)
status (optional)
url (optional)
amount (optional)

PaymentLinkedData

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.

PaymentMethodResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

PaymentPageModel

amount
currency
returnUrl
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
orderId (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
impressumUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
additionalAttributes (optional)
resources (optional)
excludeTypes (optional)
paymentReference (optional)

PaymentPageResourceModel

customerId (optional)
basketId (optional)
metadataId (optional)

PaymentPageResponseModel

id (optional)
redirectUrl (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
orderId (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
paymentReference (optional)
impressumUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
additionalAttributes (optional)
resources (optional)
action (optional)
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)

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

PaymentResponse

id (optional)
String Id of this charge transaction
isSuccess (optional)
isPending (optional)
isError (optional)
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)
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)
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)

PaymentResponseMetadata

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)
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).

PaymentResponseResources

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)
typeId (optional)
String Id of the types Resource that is to be used for this transaction.

PaymentTypeResponse

supports (optional)
type (optional)
allowCustomerTypes (optional)
googleMerchantId (optional)
allowCreditTransaction (optional)
3ds (optional)

Paypal

email (optional)
amount (optional)
currency (optional)
basketId (optional)
customerId (optional)

PaypalResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
email (optional)
connector (optional)

PrePaymentResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

Przelewy24ResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

RecurringRequest

amount (optional)
returnUrl (optional)
currency (optional)
resources (optional)

RecurringResourcesModel

customerId (optional)
metadataId (optional)

RecurringResponse

isSuccess (optional)
isPending (optional)
isError (optional)
redirectUrl (optional)
message (optional)
amount (optional)
currency (optional)
returnUrl (optional)
date (optional)
resources (optional)
processing (optional)

RedirectView

applicationContext (optional)
servletContext (optional)
contentType (optional)
requestContextAttribute (optional)
staticAttributes (optional)
exposePathVariables (optional)
exposeContextBeansAsAttributes (optional)
exposedContextBeanNames (optional)
beanName (optional)
url (optional)
contextRelative (optional)
http10Compatible (optional)
exposeModelAttributes (optional)
encodingScheme (optional)
statusCode (optional)
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)
propagateQueryParams (optional)
hosts (optional)
propagateQueryProperties (optional)
redirectView (optional)
attributes (optional)
attributesCSV (optional)
attributesMap (optional)

RedirectView_servletContext

minorVersion (optional)
Integer format: int32
attributeNames (optional)
servlets (optional)
sessionTrackingModes (optional)
Enum:
sessionCookieConfig (optional)
majorVersion (optional)
Integer format: int32
contextPath (optional)
filterRegistrations (optional)
servletContextName (optional)
effectiveMajorVersion (optional)
Integer format: int32
jspConfigDescriptor (optional)
effectiveSessionTrackingModes (optional)
Enum:
defaultSessionTrackingModes (optional)
Enum:
servletRegistrations (optional)
requestCharacterEncoding (optional)
sessionTimeout (optional)
Integer format: int32
virtualServerName (optional)
responseCharacterEncoding (optional)
servletNames (optional)
initParameterNames (optional)
effectiveMinorVersion (optional)
Integer format: int32
serverInfo (optional)
classLoader (optional)

RedirectView_servletContext_filterRegistrations

servletNameMappings (optional)
urlPatternMappings (optional)
initParameters (optional)
name (optional)
className (optional)

RedirectView_servletContext_jspConfigDescriptor_jspPropertyGroups

defaultContentType (optional)
isXml (optional)
includeCodas (optional)
pageEncoding (optional)
elIgnored (optional)
deferredSyntaxAllowedAsLiteral (optional)
errorOnUndeclaredNamespace (optional)
includePreludes (optional)
trimDirectiveWhitespaces (optional)
scriptingInvalid (optional)
buffer (optional)
urlPatterns (optional)

RedirectView_servletContext_jspConfigDescriptor_taglibs

taglibURI (optional)
taglibLocation (optional)

RedirectView_servletContext_servletRegistrations

mappings (optional)
runAsRole (optional)
initParameters (optional)
name (optional)
className (optional)

RedirectView_servletContext_sessionCookieConfig

comment (optional)
maxAge (optional)
Integer format: int32
path (optional)
domain (optional)
secure (optional)
httpOnly (optional)
name (optional)

ResponseMessage

Response message of payment Core.
code (optional)
merchant (optional)
customer (optional)

RetrieveEntity

numberOfRates (optional)
Long format: int64
dayOfPurchase (optional)
orderDate (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
installmentRates (optional)

RetrieveInstallmentRate

date (optional)
numberOfInterest (optional)
amountOfRepayment (optional)
rate (optional)
totalRemainingAmount (optional)
timePassedInYears (optional)
type (optional)
rateIndex (optional)
accumulatedInterest (optional)
ultimo (optional)

RetrieveResponse

code (optional)
description (optional)
entity (optional)

SepaDirectDebit

iban (optional)
bic (optional)
holder (optional)

SepaDirectDebitGuaranteedResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
holder (optional)

SepaDirectDebitResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
holder (optional)

SepaDirectDebitSecuredResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
holder (optional)

ShipmentModel

amount (optional)
orderId (optional)
invoiceId (optional)

SofortResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

SupportResponse

brands (optional)
countries (optional)
channel (optional)
currency (optional)

UpdatedCreditcard

number
expiryDate
String format: MM/yyyy
cvc
brand (optional)
email (optional)
cardHolder (optional)

WeChatPayResponseModel

id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)

WebhookRegistrationModel

url (optional)
event (optional)
eventList (optional)

WebhookRegistrationResponse

id (optional)
url (optional)
event (optional)

inline_object

shop_id (optional)
shop_code (optional)
invoice_number (optional)

inline_object_1

shop_id (optional)
shop_code (optional)
invoice_number (optional)