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

AliPayResponseModel

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

AliPayResponseModel

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

ApplePayResponseModel

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

ApplePayResponseModel

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

ApplePayResponseModel

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

BancontactResponseModel

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

BancontactResponseModel

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

BancontactResponseModel

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

BasketModelV1

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

BasketModelV1

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

BasketResponseModelV1

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

BasketResponseModelV1

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

BasketResponseModelV1

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

BasketResponseModelV1

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

CardResponseModel

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

CardResponseModel

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

CardResponseModel

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

CardResponseModel

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

IdResponse

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

CustomerModel

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

CustomerModel

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

CustomerModel

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

EpsResponseModel

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

EpsResponseModel

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

EpsResponseModel

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

GiroPayResponseModel

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

GiroPayResponseModel

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

GooglePayResponseModel

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

GooglePayResponseModel

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

GooglePayResponseModel

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

GooglePayResponseModel

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

HirePurchaseDDResponseModel

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

RetrieveResponse

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

HirePurchaseDDResponseModel

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

HirePurchaseDDResponseModel

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

IdealResponseModel

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

IdealResponseModel

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

IdealResponseModel

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

InstallmentSecuredResponseModel

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

RetrieveResponse

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

InstallmentSecuredResponseModel

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

InstallmentSecuredResponseModel

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

InvoiceResponseModel

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

InvoiceResponseModel

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

InvoiceFactoringResponseModel

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

InvoiceFactoringResponseModel

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

InvoiceGuaranteedResponseModel

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

InvoiceGuaranteedResponseModel

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

InvoiceSecuredResponseModel

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

InvoiceSecuredResponseModel

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

PaymentResponse

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

PaymentResponse

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

get /v1/linkpay/{id}

(get)

Path parameters

id (required)

Path Parameter — default: null

Return type

LinkPayResponse

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

LinkPayResponse

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

LinkPayResponse

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

LinkPayResponse

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

LinkPayResponse

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

LinkPayResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

KeyPairResponse

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

KeyPairResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

KeyPairResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

DigitalWalletPayCertificationResponse

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

PaymentPageResponseModel

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

PaymentPageResponseModel

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

PaymentPageResponseModel

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

PaymentPageResponseModel

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

PaymentPageResponseModel

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

MetadataResponse

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

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

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentGetResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaymentResponse

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

PaypalResponseModel

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

PaypalResponseModel

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

PaypalResponseModel

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

PFCardResponseModel

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

PFCardResponseModel

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

PFEfinanceResponseModel

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

PFEfinanceResponseModel

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

PISResponseModel

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

PISResponseModel

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

PrePaymentResponseModel

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

PrePaymentResponseModel

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

Przelewy24ResponseModel

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

Przelewy24ResponseModel

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

RecurringResponse

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

PaymentMethodResponseModel

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

RecurringResponse

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

SepaDirectDebitResponseModel

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

SepaDirectDebitResponseModel

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

SepaDirectDebitResponseModel

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

SepaDirectDebitGuaranteedResponseModel

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

SepaDirectDebitGuaranteedResponseModel

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

SepaDirectDebitResponseModel

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

SepaDirectDebitSecuredResponseModel

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

SepaDirectDebitSecuredResponseModel

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

SepaDirectDebitResponseModel

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

SofortResponseModel

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

SofortResponseModel

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

WeChatPayResponseModel

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

WeChatPayResponseModel

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

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

WebhookRegistrationResponse

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

WebhookRegistrationResponse

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

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

WebhookRegistrationResponse

{
  "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)