API Reference

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

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.

currency (optional)

Query Parameter — The currency of the order has been submitted.

orderDate (optional)

Query Parameter — The timestamp the order has been submitted.

dayOfPurchase (optional)

Query Parameter — The date of purchase the order has been submitted.

effectiveInterest (required)

Query Parameter — Target effective interest rate in Percentage.

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

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

(multipartUpdateBankInformation1)

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

!application/json
application/json

Request body

body 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

(createWithoutCustomerInfo143)

Create Ideal payment method resource.

application/json
!application/json

Request body

body 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

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

application/json
!application/json

Request body

body 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

InstallmentSecured

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

(getCardPaymentMethodResource5)

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

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.

currency (optional)

Query Parameter — The currency of the order has been submitted.

orderDate (optional)

Query Parameter — The timestamp the order has been submitted.

dayOfPurchase (optional)

Query Parameter — The date of purchase the order has been submitted.

effectiveInterest (required)

Query Parameter — Target effective interest rate in Percentage.

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

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

(multipartUpdateBankInformation2)

Update Installment-Secured payment method resource.

Path parameters

id (required)

Path Parameter — The id returns in response when calling POST /types/installment-secured

!application/json
application/json

Request body

body 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

(createWithoutCustomerInfo5)

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}

(getCardPaymentMethodResource3)

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

Return type

InvoiceResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK InvoiceResponseModel

InvoiceFactoring

post /v1/types/invoice-factoring

(createWithoutCustomerInfo7)

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

Return type

InvoiceFactoringResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK InvoiceFactoringResponseModel

InvoiceGuaranteed

post /v1/types/invoice-guaranteed

(createWithoutCustomerInfo6)

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}

(getCardPaymentMethodResource4)

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

Return type

InvoiceGuaranteedResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK InvoiceGuaranteedResponseModel

InvoiceSecured

post /v1/types/invoice-secured

(createWithoutCustomerInfo8)

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

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 —

application/json
!application/json

Request body

body 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 —

application/json
!application/json

Request body

body 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 —

Responses

200

get /v1/linkpay/{id}

(get2)

Path parameters

id (required)

Path 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

post /v1/linkpay/authorize/

(initAuthorize11)

application/json
!application/json

Request body

body 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

(initAuthorize2)

application/json
!application/json

Request body

body 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/

(initCharge11)

application/json
!application/json

Request body

body 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

body 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 —

!application/json
application/json

Request body

body 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

MerchantKeypair

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

(activateApplePayCertificate)

Activate a certicate as a default using certificate.

Path parameters

certificateId (required)

Path Parameter — The <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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",
  "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",
  "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 <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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 <id> parameter returned when the resource was created

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

body 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

body 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

body 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

body 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

MerchantPaymentPage

get /v1/paypage/{id}

(get1)

Fetch the created paymenresource.

Path parameters

id (required)

Path Parameter — The releated payment page id.

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/

(multipartRegisterAuthorizationAction11)

The initialize payment page call with authorize purpose.

!application/json
application/json

Request body

body 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

(multipartRegisterAuthorizationAction2)

The initialize payment page call with authorize purpose.

!application/json
application/json

Request body

body 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

body 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

body 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

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

Return type

map[String, String]

{
  "key" : ""
}

*/*

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

application/json

Request body

body body (required)

Body Parameter —

Return type

map[String, String]

{
  "key" : ""
}

*/*

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

body 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}/authorize/{txnCode}/cancels

(cancelAuthorizeTransactionByPayment1)

Cancels an existing authorization. The reserved money on the customers payment method will be freed up.

Path parameters

codeOrOrderId (required)

Path Parameter — The releated payment identity. This can be paymentCode or Id.

txnCode (required)

Path Parameter — The releated transaction identity (E.g: s-aut-1)

application/json
!application/json

Request body

body 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/{txnCode}/cancels

(cancelChargeTransactionByPayment1)

Cancel the charge transaction which has id = <txnCode> and is belonging to the payment with code/OrderId = <codeOrOrderId>.

Path parameters

codeOrOrderId (required)

Path Parameter — The releated payment identity. This can be paymentCode or Id.

txnCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

application/json
!application/json

Request body

body 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 = <txnCode> and is belonging to the payment with code/OrderId = <codeOrOrderId>.

Path parameters

codeOrOrderId (required)

Path Parameter — The releated payment identity. This can be paymentCode or Id.

application/json
!application/json

Request body

body 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 releated payment identity. This can be paymentCode or Id.

application/json
!application/json

Request body

body 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

body 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 releated payment identity. This can be paymentCode or Id.

cancelCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cnl-1)

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 releated payment identity. This can be paymentCode or Id.

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 releated payment identity. This can be paymentCode or Id.

txnCode (required)

Path Parameter — The releated trasaction identity (E.g: s-aut-1)

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 — format: int64

uniqueId (optional)

Query Parameter —

orderId (optional)

Query Parameter —

shortId (optional)

Query 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

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 trasaction's uuid/shortid

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 releated payment identity. This can be paymentCode or Id.

txnCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

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 releated payment identity. This can be paymentCode or Id.

chargeBackCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cbk-1)

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 releated payment identity. This can be paymentCode or Id.

chargeCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

chargeBackCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cbk-1)

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 releated payment identity. This can be paymentCode or Id.

chargeCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

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 releated payment identity. This can be paymentCode or Id.

chargeCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

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 releated payment identity. This can be paymentCode or Id.

authCode (required)

Path Parameter — The releated transaction identity (E.g: s-aut-1)

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 releated payment identity. This can be paymentCode or Id.

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 trasaction's uuid/shortid

Path parameters

anyId (required)

Path Parameter — Any possible ids. This id can be payment-id or trasaction's uuid/shortid

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 releated payment identity. This can be paymentCode or Id.

txnCode (required)

Path 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

200

OK PaymentResponse

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

(getRefundTransactionByPayment)

Fetch the corresponding canceled transaction.

Path parameters

codeOrOrderId (required)

Path Parameter — The releated payment identity. This can be paymentCode or Id.

chargeCode (required)

Path Parameter — The releated trasaction identity (E.g: s-chg-1)

cancelCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cnl-1)

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 releated payment identity. This can be paymentCode or Id.

authCode (required)

Path Parameter — The releated transaction identity (E.g: s-aut-1)

cancelCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cnl-1)

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 releated payment identity. This can be paymentCode or Id.

txncode (required)

Path Parameter — The releated trasaction identity (E.g: s-shp-1)

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 releated payment identity. This can be paymentCode or Id.

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 releated payment identity. This can be paymentCode or Id.

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 releated payment identity. This can be paymentCode or Id.

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 releated payment identity. This can be paymentCode or Id.

cancelCode (required)

Path Parameter — The releated trasaction identity (E.g: s-cnl-1)

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/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 releated payment identity. This can be paymentCode or Id.

!application/json
application/json

Request body

body 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

body 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 could not exceed the total amount.

Path parameters

codeOrOrderId (required)

Path Parameter — The releated payment identity. This can be paymentCode or Id.

application/json
!application/json

Request body

body 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

body Paypal (optional)

Body Parameter —

Form parameters

email (optional)

Form Parameter —

amount (optional)

Form Parameter —

currency (optional)

Form Parameter —

basketId (optional)

Form Parameter —

customerId (optional)

Form 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

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

application/json
!application/json

Request body

body 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

PfCard

post /v1/types/post-finance-card

(createWithoutCustomerInfo11)

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

Return type

PFCardResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK PFCardResponseModel

PfeFinance

post /v1/types/post-finance-efinance

(createWithoutCustomerInfo12)

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

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

body PIS (optional)

Body Parameter — Optional request body

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

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

(createWithoutCustomerInfo10)

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

Return type

PrePaymentResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK PrePaymentResponseModel

Properties

get /v1/properties/system

(getSystemProperties)

Return type

PropertiesResponseModel

{
  "properties" : {
    "key" : "properties"
  }
}

*/*

Responses

200

OK PropertiesResponseModel

Przelewy24

post /v1/types/przelewy24

(createWithoutCustomerInfo9)

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

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

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

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

application/json
!application/json

Request body

body 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

SepaDirectDebit

post /v1/types/sepa-direct-debit

(createWithoutCustomerInfo2)

Create Sepa-Direct-Debit payment method resource.

application/json
!application/json

Request body

body 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

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

application/json
!application/json

Request body

body 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

SepaDirectDebitGuaranteed

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

(createWithoutCustomerInfo142)

Create Sepa-Direct-Debit-Guaranteed payment method resource.

application/json
!application/json

Request body

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

(getCardPaymentMethodResource6)

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

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}

(updatePaymentMethodResource2)

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

application/json
!application/json

Request body

body 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

SepaDirectDebitSecured

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

(createWithoutCustomerInfo3)

Create Sepa-Direct-Debit-Secured payment method resource.

application/json
!application/json

Request body

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

(getCardPaymentMethodResource2)

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

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}

(updatePaymentMethodResource1)

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

application/json
!application/json

Request body

body 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

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

Return type

SofortResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK SofortResponseModel

WeChatPay

post /v1/types/wechatpay

(createWithoutCustomerInfo141)

Create WechatPay payment method resource.

application/json
!application/json

Request body

body WeChatPay (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

Return type

WeChatPayResponseModel

{
  "method" : "method",
  "geoLocation" : {
    "clientIp" : "clientIp",
    "countryIsoA2" : "countryIsoA2"
  },
  "recurring" : true,
  "customerId" : "customerId",
  "id" : "id"
}

*/*

Responses

200

OK WeChatPayResponseModel

WebhookRegistration

delete /v1/webhooks

(deleteAll)

Delete all webhooks resources which belong to the key

Return type

map[String, array[WebhookRegistrationResponse]]

{
  "key" : [ {
    "id" : "id",
    "event" : "event",
    "url" : "url"
  }, {
    "id" : "id",
    "event" : "event",
    "url" : "url"
  } ]
}

*/*

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

Return type

WebhookRegistrationResponse

{
  "id" : "id",
  "event" : "event",
  "url" : "url"
}

*/*

Responses

200

OK WebhookRegistrationResponse

get /v1/webhooks/{eventId}

(get4)

Get one specific webhook resource which belongs to the <id>

Path parameters

eventId (required)

Path Parameter — Describe the webhook eventId which will be queried from server

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

{
  "key" : [ {
    "id" : "id",
    "event" : "event",
    "url" : "url"
  }, {
    "id" : "id",
    "event" : "event",
    "url" : "url"
  } ]
}

*/*

Responses

200

post /v1/webhooks

(registerMultipart1)

Create a new webhook

application/x-www-form-urlencoded
application/json

Request body

body WebhookRegistrationModel (required)

Body Parameter —

Form parameters

url (required)

Form Parameter —

event (required)

Form Parameter —

eventList (required)

Form Parameter —

Return type

String

""

*/*

Responses

201

Created String

put /v1/webhooks/{eventId}

(updateMultipart1)

Update webhook url by <id>

Path parameters

eventId (required)

Path Parameter — Describe the webhook eventId which will be queried from server

!application/json
application/json

Request body

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

API Reference

post /v1/types/alipay

Return type

Responses

201

get /v1/types/alipay/{id}

Path parameters

Return type

Responses

200

post /v1/types/applepay

Request body

Return type

Responses

201

post /v1/types/applepay/

Request body

Return type

Responses

201

get /v1/types/applepay/{id}

Path parameters

Return type

Responses

200

post /v1/types/bancontact

Request body

Return type

Responses

201

get /v1/types/bancontact/{id}

Path parameters

Return type

Responses

200

put /v1/types/bancontact/{id}

Path parameters

Request body

Return type

Responses

200

get /v1/baskets/{basketId}

Path parameters

Return type

Responses

200

get /v1/baskets/{basketId}/

Path parameters

Return type

Responses

200

post /v1/baskets/

Request body

Return type

Responses

201

post /v1/baskets

Request body

Return type

Responses

201

put /v1/baskets/{basketId}

Path parameters

Request body

Return type

Responses

200

put /v1/baskets/{basketId}/

Path parameters

Request body

Return type

Responses

200

post /v1/types/card

Request body

Return type

Responses

201

get /v1/types/card/{id}

Path parameters

`post /v1/types/alipay`

`get /v1/types/alipay/{id}`

`post /v1/types/applepay`

`post /v1/types/applepay/`

`get /v1/types/applepay/{id}`

`post /v1/types/bancontact`

`get /v1/types/bancontact/{id}`

`put /v1/types/bancontact/{id}`

`get /v1/baskets/{basketId}`

`get /v1/baskets/{basketId}/`

`post /v1/baskets/`

`post /v1/baskets`

`put /v1/baskets/{basketId}`

`put /v1/baskets/{basketId}/`

`post /v1/types/card`

`get /v1/types/card/{id}`

`put /v1/types/card/{id}`

`patch /v1/types/card/{id}`

`delete /v1/customers/{codeOrExternalId}`

`get /v1/customers/{codeOrExternalId}`

`post /v1/customers`

`put /v1/customers/{codeOrExternalId}`

`post /v1/types/eps`

`get /v1/types/eps/{id}`

`put /v1/types/eps/{id}`

`post /v1/types/giropay`

`get /v1/types/giropay/{id}`