API Reference
Get a detailed, up-to-date look at the Unzer API reference.
Methods
AliPay
post /v1/types/alipay
post /v1/types/alipay
(createWithoutCustomerInfo13)
Create AliPay payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created AliPayResponseModel
get /v1/types/alipay/{id}
get /v1/types/alipay/{id}
(getAliPayPaymentMethodResource)
Retrieve an existed AliPay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/alipay
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK AliPayResponseModelApplePay
post /v1/types/applepay
post /v1/types/applepay
(createWithoutCustomerInfo144)
Create ApplePay payment method resource.
application/json
!application/json
Request body
body ApplePayPaymentData (required)
Body Parameter —
Return type
{
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"id" : "id",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate"
}
*/*
Responses
201
Created ApplePayResponseModel
post /v1/types/applepay/
post /v1/types/applepay/
(createWithoutCustomerInfo151)
Create ApplePay payment method resource.
application/json
!application/json
Request body
body ApplePayPaymentData (required)
Body Parameter —
Return type
{
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"id" : "id",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate"
}
*/*
Responses
201
Created ApplePayResponseModel
get /v1/types/applepay/{id}
get /v1/types/applepay/{id}
(getApplePayPaymentMethodResource)
Retrieve an existed ApplePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/applepay
Return type
{
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"id" : "id",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate"
}
*/*
Responses
200
OK ApplePayResponseModelBancontact
post /v1/types/bancontact
post /v1/types/bancontact
(createByMultipart1)
Create Bancontact payment method resource.
!application/json
application/json
Request body
body Bancontact (optional)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"holder" : "holder",
"id" : "id"
}
*/*
Responses
201
Created BancontactResponseModel
get /v1/types/bancontact/{id}
get /v1/types/bancontact/{id}
(get)
Retrieve an existed Bancontact payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/bancontact
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"holder" : "holder",
"id" : "id"
}
*/*
Responses
200
OK BancontactResponseModel
put /v1/types/bancontact/{id}
put /v1/types/bancontact/{id}
(updateByMultiPart1)
Update Bancontact payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/bancontact
!application/json
application/json
Request body
body Bancontact (required)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"holder" : "holder",
"id" : "id"
}
*/*
Responses
200
OK BancontactResponseModelBasketV1
get /v1/baskets/{basketId}
get /v1/baskets/{basketId}
(getBasket)
Get basket resource api
Path parameters
basketId (required)
Path Parameter — The <id> parameter returned when the resource was created
Return type
{
"note" : "note",
"basketItems" : [ {
"quantity" : 0,
"amountPerUnit" : 2.302136,
"vat" : 14,
"amountNet" : 7.0614014,
"amountDiscount" : 6.0274563,
"amountGross" : 5.962134,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 5.637377
}, {
"quantity" : 0,
"amountPerUnit" : 2.302136,
"vat" : 14,
"amountNet" : 7.0614014,
"amountDiscount" : 6.0274563,
"amountGross" : 5.962134,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 5.637377
} ],
"canceledBasket" : [ {
"amountTotalDiscount" : "amountTotalDiscount",
"items" : [ {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
}, {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
} ],
"amountTotalVat" : "amountTotalVat",
"timestamp" : "timestamp"
}, {
"amountTotalDiscount" : "amountTotalDiscount",
"items" : [ {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
}, {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
} ],
"amountTotalVat" : "amountTotalVat",
"timestamp" : "timestamp"
} ],
"orderId" : "s-bsk-XXX",
"amountTotal" : "amountTotal",
"id" : "id",
"amountTotalDiscount" : "amountTotalDiscount",
"currencyCode" : "EUR",
"amountTotalGross" : "amountTotalGross",
"amountTotalVat" : "amountTotalVat"
}
*/*
Responses
200
OK BasketModelV1
get /v1/baskets/{basketId}/
get /v1/baskets/{basketId}/
(getBasket1)
Get basket resource api
Path parameters
basketId (required)
Path Parameter — The <id> parameter returned when the resource was created
Return type
{
"note" : "note",
"basketItems" : [ {
"quantity" : 0,
"amountPerUnit" : 2.302136,
"vat" : 14,
"amountNet" : 7.0614014,
"amountDiscount" : 6.0274563,
"amountGross" : 5.962134,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 5.637377
}, {
"quantity" : 0,
"amountPerUnit" : 2.302136,
"vat" : 14,
"amountNet" : 7.0614014,
"amountDiscount" : 6.0274563,
"amountGross" : 5.962134,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 5.637377
} ],
"canceledBasket" : [ {
"amountTotalDiscount" : "amountTotalDiscount",
"items" : [ {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
}, {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
} ],
"amountTotalVat" : "amountTotalVat",
"timestamp" : "timestamp"
}, {
"amountTotalDiscount" : "amountTotalDiscount",
"items" : [ {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
}, {
"quantity" : "quantity",
"amountPerUnit" : 7.386282,
"vat" : 36,
"amountNet" : 1.2315135,
"amountDiscount" : 9.301444,
"amountGross" : 2.027123,
"title" : "title",
"type" : "type",
"participantId" : "participantId",
"unit" : "unit",
"subTitle" : "subTitle",
"basketItemReferenceId" : "basketItemReferenceId",
"imageUrl" : "imageUrl",
"amountVat" : 4.145608
} ],
"amountTotalVat" : "amountTotalVat",
"timestamp" : "timestamp"
} ],
"orderId" : "s-bsk-XXX",
"amountTotal" : "amountTotal",
"id" : "id",
"amountTotalDiscount" : "amountTotalDiscount",
"currencyCode" : "EUR",
"amountTotalGross" : "amountTotalGross",
"amountTotalVat" : "amountTotalVat"
}
*/*
Responses
200
OK BasketModelV1
post /v1/baskets/
post /v1/baskets/
(multiPartRegisterBasket11)
Create basket resource api
!application/json
application/json
Request body
body BasketModelV1 (required)
Body Parameter —
Return type
{
"id" : "id"
}
*/*
Responses
201
Created BasketResponseModelV1
post /v1/baskets
post /v1/baskets
(multiPartRegisterBasket2)
Create basket resource api
!application/json
application/json
Request body
body BasketModelV1 (required)
Body Parameter —
Return type
{
"id" : "id"
}
*/*
Responses
201
Created BasketResponseModelV1
put /v1/baskets/{basketId}
put /v1/baskets/{basketId}
(multiPartUpdateBasket1)
Update basket resource api
Path parameters
basketId (required)
Path Parameter — The <id> parameter returned when the resource was created
!application/json
application/json
Request body
body BasketModelV1 (required)
Body Parameter —
Return type
{
"id" : "id"
}
*/*
Responses
200
OK BasketResponseModelV1
put /v1/baskets/{basketId}/
put /v1/baskets/{basketId}/
(updateBasket)
Update basket resource api
Path parameters
basketId (required)
Path Parameter — The <id> parameter returned when the resource was created
application/json
Request body
body BasketModelV1 (required)
Body Parameter —
Return type
{
"id" : "id"
}
*/*
Responses
200
OK BasketResponseModelV1Card
post /v1/types/card
post /v1/types/card
(createWithoutCustomerInfo1)
Create CreditCard payment method resource.<br><br><b>Note:</b> This API is restricted to be called directly by SAQ-A or SAQ-EP level merchant.
application/json
!application/json
Request body
body Creditcard (required)
Body Parameter —
Return type
{
"3ds" : { },
"method" : "method",
"recurring" : true,
"cardHolder" : "cardHolder",
"type" : "type",
"expiryDate" : "expiryDate",
"number" : "number",
"cvc" : "cvc",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"cardDetails" : {
"issuerPhoneNumber" : "issuerPhoneNumber",
"issuerName" : "issuerName",
"issuerUrl" : "issuerUrl",
"cardType" : "cardType",
"countryIsoA2" : "countryIsoA2",
"countryName" : "countryName",
"account" : "account"
},
"customerId" : "customerId",
"processing" : {
"traceId" : "traceId",
"shortId" : "shortId",
"uniqueId" : "uniqueId"
},
"id" : "id",
"brand" : "brand",
"email" : "email"
}
*/*
Responses
201
Created CardResponseModel
get /v1/types/card/{id}
get /v1/types/card/{id}
(getCardPaymentMethodResource)
Retrieve an existed CreditCard payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/card
Return type
{
"3ds" : { },
"method" : "method",
"recurring" : true,
"cardHolder" : "cardHolder",
"type" : "type",
"expiryDate" : "expiryDate",
"number" : "number",
"cvc" : "cvc",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"cardDetails" : {
"issuerPhoneNumber" : "issuerPhoneNumber",
"issuerName" : "issuerName",
"issuerUrl" : "issuerUrl",
"cardType" : "cardType",
"countryIsoA2" : "countryIsoA2",
"countryName" : "countryName",
"account" : "account"
},
"customerId" : "customerId",
"processing" : {
"traceId" : "traceId",
"shortId" : "shortId",
"uniqueId" : "uniqueId"
},
"id" : "id",
"brand" : "brand",
"email" : "email"
}
*/*
Responses
200
OK CardResponseModel
put /v1/types/card/{id}
put /v1/types/card/{id}
(updateCard1)
Update CreditCard payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/card
application/json
!application/json
Request body
body UpdatedCreditcard (required)
Body Parameter —
Return type
{
"3ds" : { },
"method" : "method",
"recurring" : true,
"cardHolder" : "cardHolder",
"type" : "type",
"expiryDate" : "expiryDate",
"number" : "number",
"cvc" : "cvc",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"cardDetails" : {
"issuerPhoneNumber" : "issuerPhoneNumber",
"issuerName" : "issuerName",
"issuerUrl" : "issuerUrl",
"cardType" : "cardType",
"countryIsoA2" : "countryIsoA2",
"countryName" : "countryName",
"account" : "account"
},
"customerId" : "customerId",
"processing" : {
"traceId" : "traceId",
"shortId" : "shortId",
"uniqueId" : "uniqueId"
},
"id" : "id",
"brand" : "brand",
"email" : "email"
}
*/*
Responses
200
OK CardResponseModel
patch /v1/types/card/{id}
patch /v1/types/card/{id}
(updateCardEmail1)
Add/Update email of an existing CreditCard payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling PATCH /types/card
application/json
!application/json
Request body
body UpdatedEmailCreditcard (optional)
Body Parameter —
Return type
{
"3ds" : { },
"method" : "method",
"recurring" : true,
"cardHolder" : "cardHolder",
"type" : "type",
"expiryDate" : "expiryDate",
"number" : "number",
"cvc" : "cvc",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"cardDetails" : {
"issuerPhoneNumber" : "issuerPhoneNumber",
"issuerName" : "issuerName",
"issuerUrl" : "issuerUrl",
"cardType" : "cardType",
"countryIsoA2" : "countryIsoA2",
"countryName" : "countryName",
"account" : "account"
},
"customerId" : "customerId",
"processing" : {
"traceId" : "traceId",
"shortId" : "shortId",
"uniqueId" : "uniqueId"
},
"id" : "id",
"brand" : "brand",
"email" : "email"
}
*/*
Responses
200
OK CardResponseModelCustomer
delete /v1/customers/{codeOrExternalId}
delete /v1/customers/{codeOrExternalId}
(delete1)
Delete a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId.
Return type
{
"id" : "id"
}
*/*
Responses
200
OK IdResponse
get /v1/customers/{codeOrExternalId}
get /v1/customers/{codeOrExternalId}
(get3)
Fetch a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId.
Return type
{
"firstname" : "firstname",
"companyInfo" : {
"registrationType" : "registrationType",
"commercialRegisterNumber" : "commercialRegisterNumber",
"function" : "function",
"commercialSector" : "commercialSector"
},
"mobile" : "mobile",
"birthDate" : "birthDate",
"lastname" : "lastname",
"phone" : "phone",
"customerId" : "customerId",
"company" : "company",
"id" : "id",
"salutation" : "salutation",
"billingAddress" : {
"zip" : "zip",
"country" : "country",
"city" : "city",
"street" : "street",
"name" : "name",
"state" : "state"
},
"email" : "email"
}
*/*
Responses
200
OK CustomerModel
post /v1/customers
post /v1/customers
(multipartCreate1)
Store customer data to be used in authorize or charges calls
!application/json
application/json
Request body
body CustomerModel (required)
Body Parameter —
Return type
{
"firstname" : "firstname",
"companyInfo" : {
"registrationType" : "registrationType",
"commercialRegisterNumber" : "commercialRegisterNumber",
"function" : "function",
"commercialSector" : "commercialSector"
},
"mobile" : "mobile",
"birthDate" : "birthDate",
"lastname" : "lastname",
"phone" : "phone",
"customerId" : "customerId",
"company" : "company",
"id" : "id",
"salutation" : "salutation",
"billingAddress" : {
"zip" : "zip",
"country" : "country",
"city" : "city",
"street" : "street",
"name" : "name",
"state" : "state"
},
"email" : "email"
}
*/*
Responses
201
Created CustomerModel
put /v1/customers/{codeOrExternalId}
put /v1/customers/{codeOrExternalId}
(multipartUpdate2)
Update a customer using unique customerId or the resource id from the customers resource
Path parameters
codeOrExternalId (required)
Path Parameter — The customer identifier. This can be customer code or externalId.
!application/json
application/json
Request body
body CustomerModel (optional)
Body Parameter —
Return type
{
"firstname" : "firstname",
"companyInfo" : {
"registrationType" : "registrationType",
"commercialRegisterNumber" : "commercialRegisterNumber",
"function" : "function",
"commercialSector" : "commercialSector"
},
"mobile" : "mobile",
"birthDate" : "birthDate",
"lastname" : "lastname",
"phone" : "phone",
"customerId" : "customerId",
"company" : "company",
"id" : "id",
"salutation" : "salutation",
"billingAddress" : {
"zip" : "zip",
"country" : "country",
"city" : "city",
"street" : "street",
"name" : "name",
"state" : "state"
},
"email" : "email"
}
*/*
Responses
200
OK CustomerModelEps
post /v1/types/eps
post /v1/types/eps
(createWithoutCustomerInfo101)
Create EPS payment method resource.
application/json
!application/json
Request body
body Eps (optional)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
201
Created EpsResponseModel
get /v1/types/eps/{id}
get /v1/types/eps/{id}
(getEPSPaymentMethodResource)
Retrieve an existed EPS payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/eps
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK EpsResponseModel
put /v1/types/eps/{id}
put /v1/types/eps/{id}
(updateEpsMultiPart1)
Update EPS payment method resource.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/eps
!application/json
application/json
Request body
body Eps (required)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK EpsResponseModelGiroPay
post /v1/types/giropay
post /v1/types/giropay
(createWithoutCustomerInfo4)
Create Giropay payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created GiroPayResponseModel
get /v1/types/giropay/{id}
get /v1/types/giropay/{id}
(getGiropayPaymentMethodResource)
Retrieve an existed Giropay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/giropay
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK GiroPayResponseModelGooglePay
post /v1/types/googlepay
post /v1/types/googlepay
(createWithoutCustomerInfo145)
Create GooglePay payment method resource.
application/json
!application/json
Request body
body GooglePayPaymentData (required)
Body Parameter —
Return type
{
"expirationYear" : "expirationYear",
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"messageExpiration" : "messageExpiration",
"recurring" : true,
"messageId" : "messageId",
"expirationMonth" : "expirationMonth",
"eciIndicator" : "eciIndicator",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"paymentMethod" : "paymentMethod",
"id" : "id",
"pan" : "pan",
"authMethod" : "authMethod",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate",
"cryptogram" : "cryptogram"
}
*/*
Responses
201
Created GooglePayResponseModel
post /v1/types/googlepay/
post /v1/types/googlepay/
(createWithoutCustomerInfo152)
Create GooglePay payment method resource.
application/json
!application/json
Request body
body GooglePayPaymentData (required)
Body Parameter —
Return type
{
"expirationYear" : "expirationYear",
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"messageExpiration" : "messageExpiration",
"recurring" : true,
"messageId" : "messageId",
"expirationMonth" : "expirationMonth",
"eciIndicator" : "eciIndicator",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"paymentMethod" : "paymentMethod",
"id" : "id",
"pan" : "pan",
"authMethod" : "authMethod",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate",
"cryptogram" : "cryptogram"
}
*/*
Responses
201
Created GooglePayResponseModel
get /v1/types/googlepay/{id}
get /v1/types/googlepay/{id}
(getGooglePayPaymentMethodResource)
Retrieve an existed GooglePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/googlepay
Return type
{
"expirationYear" : "expirationYear",
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"messageExpiration" : "messageExpiration",
"recurring" : true,
"messageId" : "messageId",
"expirationMonth" : "expirationMonth",
"eciIndicator" : "eciIndicator",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"paymentMethod" : "paymentMethod",
"id" : "id",
"pan" : "pan",
"authMethod" : "authMethod",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate",
"cryptogram" : "cryptogram"
}
*/*
Responses
200
OK GooglePayResponseModel
get /v1/types/googlepay/{id}/
get /v1/types/googlepay/{id}/
(getGooglePayPaymentMethodResource1)
Retrieve an existed GooglePay payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/googlepay
Return type
{
"expirationYear" : "expirationYear",
"method" : "method",
"applicationPrimaryAccountNumber" : "applicationPrimaryAccountNumber",
"messageExpiration" : "messageExpiration",
"recurring" : true,
"messageId" : "messageId",
"expirationMonth" : "expirationMonth",
"eciIndicator" : "eciIndicator",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"transactionAmount" : "transactionAmount",
"customerId" : "customerId",
"paymentMethod" : "paymentMethod",
"id" : "id",
"pan" : "pan",
"authMethod" : "authMethod",
"currencyCode" : "currencyCode",
"applicationExpirationDate" : "applicationExpirationDate",
"cryptogram" : "cryptogram"
}
*/*
Responses
200
OK GooglePayResponseModelHirePurchaseDd
get /v1/types/hire-purchase-direct-debit/{id}
get /v1/types/hire-purchase-direct-debit/{id}
(getCardPaymentMethodResource1)
Retrieve an existed Hire-Purchase payment method resource by id.
Path parameters
id (required)
Path Parameter — The id returns in response when calling POST /types/hire-purchase-direct-debit
Return type
{
"method" : "method",
"feePerRate" : "feePerRate",
"recurring" : true,
"monthlyRate" : "monthlyRate",
"nominalInterestRate" : "nominalInterestRate",
"invoiceDate" : "invoiceDate",
"invoiceDueDate" : "invoiceDueDate",
"feeFirstRate" : "feeFirstRate",
"accountHolder" : "accountHolder",
"totalAmount" : "totalAmount",
"totalInterestAmount" : "totalInterestAmount",
"lastRate" : "lastRate",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"iban" : "iban",
"customerId" : "customerId",
"id" : "id",
"dayOfPurchase" : "dayOfPurchase",
"totalPurchaseAmount" : "totalPurchaseAmount",
"bic" : "bic",
"orderDate" : "orderDate",
"effectiveInterestRate" : "effectiveInterestRate",
"numberOfRates" : "numberOfRates"
}
*/*
Responses
200
OK HirePurchaseDDResponseModel
get /v1/types/hire-purchase-direct-debit/plans
get /v1/types/hire-purchase-direct-debit/plans
(getPlans)
Retreive available installment plans for a given purchaseAmount and orderDate.<br><br>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
{
"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
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
{
"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}
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
{
"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 HirePurchaseDDResponseModelIdeal
post /v1/types/ideal
post /v1/types/ideal
(createWithoutCustomerInfo143)
Create Ideal payment method resource.
application/json
!application/json
Request body
body Ideal (optional)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
201
Created IdealResponseModel
get /v1/types/ideal/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK IdealResponseModel
put /v1/types/ideal/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK IdealResponseModelInstallmentSecured
get /v1/types/installment-secured/{id}
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
{
"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
get /v1/types/installment-secured/plans
(getPlans1)
Retreive available installment plans for a given purchaseAmount and orderDate.<br><br>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
{
"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
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
{
"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}
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
{
"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 InstallmentSecuredResponseModelInvoice
post /v1/types/invoice
post /v1/types/invoice
(createWithoutCustomerInfo5)
Create Invoice payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created InvoiceResponseModel
get /v1/types/invoice/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK InvoiceResponseModelInvoiceFactoring
post /v1/types/invoice-factoring
post /v1/types/invoice-factoring
(createWithoutCustomerInfo7)
Create Invoice-Factoring payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created InvoiceFactoringResponseModel
get /v1/types/invoice-factoring/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK InvoiceFactoringResponseModelInvoiceGuaranteed
post /v1/types/invoice-guaranteed
post /v1/types/invoice-guaranteed
(createWithoutCustomerInfo6)
Create Invoice-Guaranteed payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created InvoiceGuaranteedResponseModel
get /v1/types/invoice-guaranteed/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK InvoiceGuaranteedResponseModelInvoiceSecured
post /v1/types/invoice-secured
post /v1/types/invoice-secured
(createWithoutCustomerInfo8)
Create Invoice-Secured payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created InvoiceSecuredResponseModel
get /v1/types/invoice-secured/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK InvoiceSecuredResponseModelLinkPay
post /v1/linkpay/{aliasOrId}/authorize
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
{
"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
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
{
"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/linkpay/{id}
get /v1/linkpay/{id}
(get2)
Path parameters
id (required)
Path Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
200
OK LinkPayResponse
post /v1/linkpay/authorize/
post /v1/linkpay/authorize/
(initAuthorize11)
application/json
!application/json
Request body
body LinkPayRequest (required)
Body Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
201
Created LinkPayResponse
post /v1/linkpay/authorize
post /v1/linkpay/authorize
(initAuthorize2)
application/json
!application/json
Request body
body LinkPayRequest (required)
Body Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
201
Created LinkPayResponse
post /v1/linkpay/charge/
post /v1/linkpay/charge/
(initCharge11)
application/json
!application/json
Request body
body LinkPayRequest (required)
Body Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
201
Created LinkPayResponse
post /v1/linkpay/charge
post /v1/linkpay/charge
(initCharge2)
application/json
!application/json
Request body
body LinkPayRequest (required)
Body Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
201
Created LinkPayResponse
put /v1/linkpay/{id}
put /v1/linkpay/{id}
(multipartUpdate1)
Path parameters
id (required)
Path Parameter —
!application/json
application/json
Request body
body LinkPayUpdateRequest (required)
Body Parameter —
Return type
{
"css" : {
"key" : "css"
},
"expires" : "expires",
"redirectUrl" : "redirectUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"oneTimeUse" : "oneTimeUse",
"successfullyProcessed" : "successfullyProcessed",
"invoiceIdRequired" : "invoiceIdRequired",
"orderIdRequired" : "orderIdRequired",
"alias" : "alias",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"version" : "version",
"privacyPolicyUrl" : "privacyPolicyUrl",
"intention" : "intention",
"card3ds" : "card3ds",
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
200
OK LinkPayResponseMerchantKeypair
post /v1/keypair/applepay/certificates/{certificateId}/activate
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
{
"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
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
{
"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}
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
{
"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}
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
{
"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}/
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
{
"private-key" : "private-key",
"format" : "format",
"certificate" : "certificate",
"active" : true,
"id" : "id",
"type" : "type",
"paymentType" : "paymentType"
}
*/*
Responses
200
OK DigitalWalletPayCertificationResponse
get /v1/keypair
get /v1/keypair
(getAvailablePaymentMethodTypes)
Provides the public key of the used private key as well as a list of the payment types available for the merchant.
Return type
{
"captchaFeatureEnable" : "captchaFeatureEnable",
"availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
"publicKey" : "publicKey",
"login" : "login",
"isAllowedPaypalOT" : "isAllowedPaypalOT",
"merchantName" : "merchantName",
"privateKey" : "privateKey",
"senderId" : "senderId",
"password" : "password",
"validateBasket" : "validateBasket",
"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
get /v1/keypair/types
(getAvailablePaymentMethodTypesWithTypeInformation)
Provides the public key of the used private key as well as a detailed list of the payment types available for the merchant.
Return type
{
"captchaFeatureEnable" : "captchaFeatureEnable",
"availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
"publicKey" : "publicKey",
"login" : "login",
"isAllowedPaypalOT" : "isAllowedPaypalOT",
"merchantName" : "merchantName",
"privateKey" : "privateKey",
"senderId" : "senderId",
"password" : "password",
"validateBasket" : "validateBasket",
"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}
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
{
"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}
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
{
"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}/
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
{
"private-key" : "private-key",
"format" : "format",
"certificate" : "certificate",
"active" : true,
"id" : "id",
"type" : "type",
"paymentType" : "paymentType"
}
*/*
Responses
200
OK DigitalWalletPayCertificationResponse
put /v1/keypair/renew
put /v1/keypair/renew
(regenerateKeypair)
Change the private key, the public key will remain the same. It can only be triggered using the private key as parameter.
Return type
{
"captchaFeatureEnable" : "captchaFeatureEnable",
"availablePaymentTypes" : [ "availablePaymentTypes", "availablePaymentTypes" ],
"publicKey" : "publicKey",
"login" : "login",
"isAllowedPaypalOT" : "isAllowedPaypalOT",
"merchantName" : "merchantName",
"privateKey" : "privateKey",
"senderId" : "senderId",
"password" : "password",
"validateBasket" : "validateBasket",
"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
post /v1/keypair/applepay/certificates
(registerAppleCertification)
Uploads your Apple Pay certificate to Unzer.
application/json
Request body
body DigitalWalletPayCertification (required)
Body Parameter —
Return type
{
"private-key" : "private-key",
"format" : "format",
"certificate" : "certificate",
"active" : true,
"id" : "id",
"type" : "type",
"paymentType" : "paymentType"
}
*/*
Responses
201
Created DigitalWalletPayCertificationResponse
post /v1/keypair/applepay/privatekeys
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
{
"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
post /v1/keypair/googlepay/certificates
(registerGoogleCertification)
Uploads your Google Pay certificate to Unzer.
application/json
Request body
body DigitalWalletPayCertification (required)
Body Parameter —
Return type
{
"private-key" : "private-key",
"format" : "format",
"certificate" : "certificate",
"active" : true,
"id" : "id",
"type" : "type",
"paymentType" : "paymentType"
}
*/*
Responses
201
Created DigitalWalletPayCertificationResponse
post /v1/keypair/googlepay/privatekeys
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
{
"private-key" : "private-key",
"format" : "format",
"certificate" : "certificate",
"active" : true,
"id" : "id",
"type" : "type",
"paymentType" : "paymentType"
}
*/*
Responses
201
Created DigitalWalletPayCertificationResponseMerchantPaymentPage
get /v1/paypage/{id}
get /v1/paypage/{id}
(get1)
Fetch the created paymenresource.
Path parameters
id (required)
Path Parameter — The releated payment page id.
Return type
{
"css" : {
"key" : "css"
},
"redirectUrl" : "redirectUrl",
"impressumUrl" : "impressumUrl",
"orderId" : "orderId",
"shopName" : "shopName",
"action" : "CHARGE",
"currency" : "currency",
"id" : "id",
"imprintUrl" : "imprintUrl",
"returnUrl" : "returnUrl",
"shippingAddressRequired" : "shippingAddressRequired",
"amount" : "amount",
"billingAddressRequired" : "billingAddressRequired",
"excludeTypes" : [ "excludeTypes", "excludeTypes" ],
"paymentReference" : "paymentReference",
"termsAndConditionUrl" : "termsAndConditionUrl",
"helpUrl" : "helpUrl",
"resources" : {
"basketId" : "basketId",
"metadataId" : "metadataId",
"customerId" : "customerId"
},
"privacyPolicyUrl" : "privacyPolicyUrl",
"card3ds" : { },
"logoImage" : "logoImage",
"shopDescription" : "shopDescription",
"fullPageImage" : "fullPageImage",
"tagline" : "tagline",
"contactUrl" : "contactUrl",
"invoiceId" : "invoiceId",
"additionalAttributes" : {
"key" : "additionalAttributes"
}
}
*/*
Responses
200
OK PaymentPageResponseModel
post /v1/paypage/authorize/
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
{
"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
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
{
"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/
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
{
"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
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
{
"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 PaymentPageResponseModelMetadata
post /v1/metadata
post /v1/metadata
(createMetadata1)
Create the metadata resource.
application/json
Request body
body body_1 (required)
Body Parameter —
Return type
{
"id" : "id"
}
*/*
Responses
201
Created MetadataResponse
get /v1/metadata/{id}
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
OK
put /v1/metadata/{id}
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
OKPayment
post /v1/payments/authorize
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
{
"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
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
{
"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
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
{
"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
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
{
"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
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
{
"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
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
{
"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}
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
{
"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
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
{
"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}
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
{
"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
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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
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
{
"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
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
{
"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
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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}
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
{
"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
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
{
"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
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
{
"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
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
{
"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}
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
{
"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
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
{
"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
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
{
"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
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
{
"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 PaymentResponsePaypal
post /v1/types/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
{
"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}
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
{
"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}
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
{
"method" : "method",
"connector" : "connector",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id",
"email" : "email"
}
*/*
Responses
200
OK PaypalResponseModelPfCard
post /v1/types/post-finance-card
post /v1/types/post-finance-card
(createWithoutCustomerInfo11)
Create Post-Finance-Card payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created PFCardResponseModel
get /v1/types/post-finance-card/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK PFCardResponseModelPfeFinance
post /v1/types/post-finance-efinance
post /v1/types/post-finance-efinance
(createWithoutCustomerInfo12)
Create Post-Finance-eFinance payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created PFEfinanceResponseModel
get /v1/types/post-finance-efinance/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK PFEfinanceResponseModelPis
post /v1/types/pis
post /v1/types/pis
(createFlexipay1)
Create PIS payment method resource.
application/json
!application/json
Request body
body PIS (optional)
Body Parameter — <b>Optional request body</b>
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"iban" : "iban",
"customerId" : "customerId",
"holder" : "holder",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
201
Created PISResponseModel
get /v1/types/pis/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"iban" : "iban",
"customerId" : "customerId",
"holder" : "holder",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK PISResponseModelPrePayment
post /v1/types/prepayment
post /v1/types/prepayment
(createWithoutCustomerInfo10)
Create Prepayment payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created PrePaymentResponseModel
get /v1/types/prepayment/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK PrePaymentResponseModelProperties
get /v1/properties/system
get /v1/properties/system
(getSystemProperties)
Return type
{
"properties" : {
"key" : "properties"
}
}
*/*
Responses
200
OK PropertiesResponseModelPrzelewy24
post /v1/types/przelewy24
post /v1/types/przelewy24
(createWithoutCustomerInfo9)
Create Przelewy24 payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created Przelewy24ResponseModel
get /v1/types/przelewy24/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK Przelewy24ResponseModelRecurring
get /v1/types/{methodId}/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
{
"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
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created PaymentMethodResponseModel
post /v1/types/{methodId}/recurring
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
{
"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 RecurringResponseSepaDirectDebit
post /v1/types/sepa-direct-debit
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
{
"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}
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
{
"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}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"iban" : "iban",
"customerId" : "customerId",
"holder" : "holder",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK SepaDirectDebitResponseModelSepaDirectDebitGuaranteed
post /v1/types/sepa-direct-debit-guaranteed
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
{
"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}
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
{
"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}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"iban" : "iban",
"customerId" : "customerId",
"holder" : "holder",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK SepaDirectDebitResponseModelSepaDirectDebitSecured
post /v1/types/sepa-direct-debit-secured
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
{
"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}
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
{
"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}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"iban" : "iban",
"customerId" : "customerId",
"holder" : "holder",
"id" : "id",
"bic" : "bic"
}
*/*
Responses
200
OK SepaDirectDebitResponseModelSofort
post /v1/types/sofort
post /v1/types/sofort
(createWithoutCustomerInfo)
Create Sofort payment method resource.
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created SofortResponseModel
get /v1/types/sofort/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK SofortResponseModelWeChatPay
post /v1/types/wechatpay
post /v1/types/wechatpay
(createWithoutCustomerInfo141)
Create WechatPay payment method resource.
application/json
!application/json
Request body
body WeChatPay (optional)
Body Parameter —
Return type
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
201
Created WeChatPayResponseModel
get /v1/types/wechatpay/{id}
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
{
"method" : "method",
"geoLocation" : {
"clientIp" : "clientIp",
"countryIsoA2" : "countryIsoA2"
},
"recurring" : true,
"customerId" : "customerId",
"id" : "id"
}
*/*
Responses
200
OK WeChatPayResponseModelWebhookRegistration
delete /v1/webhooks
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
OK
delete /v1/webhooks/{eventId}
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
{
"id" : "id",
"event" : "event",
"url" : "url"
}
*/*
Responses
200
OK WebhookRegistrationResponse
get /v1/webhooks/{eventId}
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
{
"id" : "id",
"event" : "event",
"url" : "url"
}
*/*
Responses
200
OK WebhookRegistrationResponse
get /v1/webhooks
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
OK
post /v1/webhooks
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}
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
{
"id" : "id",
"event" : "event",
"url" : "url"
}
*/*
Responses
200
OK WebhookRegistrationResponseModels
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)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
ApplePayPaymentData
version (optional)
data (optional)
signature (optional)
header (optional)
Bancontact
holder (optional)
BasketCancelModelV1
Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
amountTotalDiscount
String Total discount amount of the whole basket in the specified currency, wich will be subtracted from the amountTotal. It should equal the sum of all basketItems.amountGross.
amountTotalVat (optional)
timestamp (optional)
items (optional)
array[BasketItemCancelModelV1] Only valid for marketplace payment: The canceled basket resource
BasketItemCancelModelV1
Only valid for marketplace payment: The canceled basket resource
basketItemReferenceId
String Unique basket item reference ID (within the basket)
unit (optional)
String Unit description of the item e.g. "pc" (Only in response).
quantity
String Quantity of the basket item.
amountDiscount (optional)
Float Discount amount for the basket item (Only in response). format: float
vat (optional)
Integer Vat value for the basket item in percent (Only in response) format: int32
amountGross
Float Gross amount = amountNet + amountVat in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item (Only in response). format: float
amountPerUnit (optional)
Float NET amount per unit (Only in response). format: float
amountNet (optional)
Float Net amount. Equals amountGross if vat value is 0 (Only in response). format: float
title (optional)
String Title of the basket item (max. 255)
subTitle (optional)
String The defined subTitle which is displayed on our Payment Page later on (Only in response).
imageUrl (optional)
String The defined imageUrl for the related basketItem and will be displayed on our Payment Page (Only in response)
participantId
String Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
String Type of the basket item, e. g. "goods", "shipment", "voucher", "digital" or "physical"
BasketItemModelV1
basketItemReferenceId (optional)
String Unique basket item reference ID (within the basket)
unit (optional)
String Unit description of the item e.g. "pc"
quantity
Integer Quantity of the basket item format: int32
amountDiscount (optional)
Float Discount amount for the basket item (multiplied by the basketItems.quantity) format: float
vat (optional)
Integer Vat value for the basket item in percent (0-100) format: int32
amountGross (optional)
Float Gross amount (= amountNet + amountVat) in the specified currency. Equals amountNet if vat value is 0 format: float
amountVat (optional)
Float Vat amount. Equals 0 if vat value is 0. Should equal the basketItems.vat multiplied by basketItems.amountNet for each basket item. format: float
amountPerUnit
Float NET amount per unit format: float
amountNet (optional)
Float Net amount. Equals amountGross if vat value is 0. format: float
title
String Title of the basket item (max. 255)
subTitle (optional)
String The defined subTitle which is displayed on our Payment Page later on
imageUrl (optional)
String The defined imageUrl for the related basketItem and will be displayed on our Payment Page
participantId (optional)
String Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
type (optional)
BasketModelV1
id (optional)
amountTotal (optional)
amountTotalGross (optional)
amountTotalDiscount (optional)
amountTotalVat (optional)
currencyCode (optional)
example: EUR
orderId
example: s-bsk-XXX
note (optional)
basketItems (optional)
canceledBasket (optional)
array[BasketCancelModelV1] Only valid for response GET /v1/baskets/{basketId}: list of canceled basket items.
BasketResponseModelV1
id (optional)
CaptureModel
amount (optional)
String Amount in decimal values (e.g. EUR 12.20). If not provide, charge full amount of authorization.
orderId (optional)
String Order id that is assigned to the payment on merchant side.
invoiceId (optional)
String Invoice id that is assigned to the payment on merchant side. Max-length = 256
paymentReference (optional)
String The transaction description.
CardResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
number (optional)
type (optional)
brand (optional)
email (optional)
3ds (optional)
cvc (optional)
expiryDate (optional)
cardHolder (optional)
cardDetails (optional)
processing (optional)
CompanyInfoModel
Only valid for B2B setting
registrationType (optional)
String The fix value for B2B customers only ('registered'/'not_registered')
commercialRegisterNumber (optional)
String The identify your company or limited partnership and verify its legal existence as an incorporated entity
function (optional)
String The identify your working function
commercialSector (optional)
String The identify your working commercial sector
CustomerModel
id (optional)
String Customer's generated code by Unzer's Payment
lastname
String Customer's lastname.
firstname
String Customer's firstname
salutation (optional)
String Must be either 'mr', 'mrs' or 'unknown'
company (optional)
String Company name
customerId (optional)
String Must be unique and identifies the customer. Can be used in place of the resource id
birthDate (optional)
String Birthdate of the customer in format yyyy-mm-dd or dd.mm.yyyy
email (optional)
String Customer's email
phone (optional)
String Customer's phone
mobile (optional)
String Customer's mobile
billingAddress (optional)
shippingAddress (optional)
companyInfo (optional)
GiroPayResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
GooglePayBillingAddress
ephemeralPublicKey (optional)
publicKeyHash (optional)
transactionId (optional)
name (optional)
address1 (optional)
address2 (optional)
address3 (optional)
sortingCode (optional)
postalCode (optional)
countryCode (optional)
locality (optional)
administrativeArea (optional)
GooglePayPaymentData
version (optional)
data (optional)
signature (optional)
header (optional)
apiVersionMinor (optional)
apiVersion (optional)
paymentMethodData (optional)
shippingAddress (optional)
GooglePayPaymentMethodData
description (optional)
tokenizationData (optional)
type (optional)
info (optional)
GooglePayPaymentMethodDataInfo
version (optional)
data (optional)
signature (optional)
header (optional)
cardNetwork (optional)
cardDetails (optional)
billingAddress (optional)
GooglePayResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
applicationPrimaryAccountNumber (optional)
applicationExpirationDate (optional)
currencyCode (optional)
transactionAmount (optional)
messageId (optional)
messageExpiration (optional)
paymentMethod (optional)
expirationYear (optional)
expirationMonth (optional)
pan (optional)
authMethod (optional)
cryptogram (optional)
eciIndicator (optional)
GooglePayShippingAddress
ephemeralPublicKey (optional)
publicKeyHash (optional)
transactionId (optional)
name (optional)
address1 (optional)
address2 (optional)
address3 (optional)
sortingCode (optional)
postalCode (optional)
countryCode (optional)
locality (optional)
administrativeArea (optional)
HirePurchaseDD
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
numberOfRates
dayOfPurchase
totalPurchaseAmount
totalInterestAmount
totalAmount
effectiveInterestRate
nominalInterestRate
feeFirstRate
feePerRate
monthlyRate
lastRate
HirePurchaseDDResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
numberOfRates (optional)
dayOfPurchase (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
IdResponse
id (optional)
String Id of deleted resource
InstallmentSecured
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
numberOfRates
dayOfPurchase
totalPurchaseAmount
totalInterestAmount
totalAmount
effectiveInterestRate
nominalInterestRate
feeFirstRate
feePerRate
monthlyRate
lastRate
InstallmentSecuredResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
iban (optional)
bic (optional)
accountHolder (optional)
orderDate (optional)
numberOfRates (optional)
dayOfPurchase (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
invoiceDate (optional)
invoiceDueDate (optional)
InvoiceFactoringResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
InvoiceGuaranteedResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
InvoiceResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
InvoiceSecuredResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
KeyPairResponse
publicKey (optional)
privateKey (optional)
senderId (optional)
login (optional)
password (optional)
secureLevel (optional)
alias (optional)
merchantName (optional)
merchantAddress (optional)
paymentTypes (optional)
availablePaymentTypes (optional)
cof (optional)
validateBasket (optional)
captchaFeatureEnable (optional)
coreId (optional)
isAllowedPaypalOT (optional)
enableMandatory3dsEmail (optional)
LinkPayRequest
alias (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
orderId (optional)
invoiceId (optional)
expires (optional)
intention (optional)
paymentReference (optional)
additionalAttributes (optional)
resources (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)
LinkPayResourceModel
customerId (optional)
LinkPayResponse
id (optional)
redirectUrl (optional)
version (optional)
alias (optional)
orderId (optional)
invoiceId (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
expires (optional)
intention (optional)
paymentReference (optional)
additionalAttributes (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)
resources (optional)
action (optional)
Enum:
CHARGE
AUTHORIZE
LinkPayUpdateRequest
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
orderId (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
expires (optional)
additionalAttributes (optional)
intention (optional)
resources (optional)
orderIdRequired (optional)
invoiceIdRequired (optional)
oneTimeUse (optional)
successfullyProcessed (optional)
excludeTypes (optional)
MetadataResponse
id (optional)
PFCardResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
PFEfinanceResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
PaymentGetResponse
id (optional)
String The id of payment (ex: s-pay-1).
state (optional)
amount (optional)
currency (optional)
String <a href='https://en.wikipedia.org/wiki/ISO_4217#Active_codes'>iso currency code</a>
orderId (optional)
String Order id of the merchant application. This id can also be used to get payments from the api. The id has to be unique for the used key pair.
invoiceId (optional)
String InvoiceId of the merchant.
resources (optional)
transactions (optional)
array[PaymentGetResponseTransaction] List of subsequence transaction(s).
card3ds (optional)
PaymentGetResponseAmount
Summary of all amounts
total (optional)
Float Initial amount reduced by cancellations during authorization format: float
charged (optional)
Float Already charged amount format: float
canceled (optional)
Float Refunded amount of all charges format: float
remaining (optional)
Float Difference between total and charged format: float
PaymentGetResponseState
Current state of this payment<br><i>pending (0)<br>completed (1)<br>canceled (2)<br>partly (3)<br>payment review (4)<br>chargeback</i>
PaymentGetResponseTransaction
List of subsequence transaction(s).
PaymentLinkedData
customerId (optional)
String The id of the Customer resource to be used. We accept the merchant's customerCode.
example: s-cst-xxx
typeId
String The id of the Payment types resource to be used.
example: s-crd-xxx
metadataId (optional)
String The id of the Metadata resource to be used.
example: s-mtd-xxx
basketId (optional)
String The id of the Basket resource to be used.
example: s-bsk-xxx
PaymentMethodResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
PaymentPageModel
amount
currency
returnUrl
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
orderId (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
impressumUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
additionalAttributes (optional)
resources (optional)
excludeTypes (optional)
paymentReference (optional)
PaymentPageResponseModel
id (optional)
redirectUrl (optional)
amount (optional)
currency (optional)
returnUrl (optional)
logoImage (optional)
fullPageImage (optional)
shopName (optional)
shopDescription (optional)
tagline (optional)
css (optional)
orderId (optional)
termsAndConditionUrl (optional)
privacyPolicyUrl (optional)
paymentReference (optional)
impressumUrl (optional)
imprintUrl (optional)
helpUrl (optional)
contactUrl (optional)
invoiceId (optional)
card3ds (optional)
billingAddressRequired (optional)
shippingAddressRequired (optional)
additionalAttributes (optional)
resources (optional)
action (optional)
Enum:
CHARGE
AUTHORIZE
excludeTypes (optional)
PaymentRequest
amount
String Amount in possitive decimal values. Accepted length: Decimal{10,4}.
example: 100.5
currency
String Currency in ISO Alpha 3 notation.
example: EUR
returnUrl (optional)
String URL to redirect the customer after the payment is completed (in case of redirect payments e.g. Paypal, Sofort). Required in condition.
card3ds (optional)
Boolean Only valid for Card method: Overrides the existing credit card configuration if possible.
example: false
paymentReference (optional)
String Transaction description
orderId (optional)
String Order id that identifies the payment on merchant side.
invoiceId (optional)
String invoice id that is assigned to the payment on merchant side
effectiveInterestRate (optional)
String Only valid for Installment method: The affected installment rated. Required incase of Installment method.
resources
PaymentResponse
id (optional)
String Id of this charge transaction
isSuccess (optional)
isPending (optional)
isError (optional)
card3ds (optional)
Boolean Indicate a 3ds transaction (card payment type only).
redirectUrl (optional)
String Some payment methods require the customer to leave the merchant application. This URL is used to bring the customer back to your application..
message (optional)
amount (optional)
Float The amount to be authorized on the specified account. The amount is rounded depending on the respective currency. format: float
effectiveInterestRate (optional)
String Only valid for Installment method: The affected installment rated. Required incase of Installment method.
currency (optional)
String ISO currency code. You can find a list of all codes on the <a href='https://docs.unzer.com/docs/amounts-and-currencies'>Amounts and Currencies</a> overview page.
returnUrl (optional)
String If customer's confirmation is required, a redirect URL will be return.
Customer needs to be redirected to this URL and proceed the confirmation.
date (optional)
String Timestamp of this transaction.
resources (optional)
orderId (optional)
String Order id that identifies the payment on merchant side.
invoiceId (optional)
String invoice id that is assigned to the payment on merchant side
paymentReference (optional)
String Transaction description.
processing (optional)
PaymentResponseMetadata
creatorId (optional)
String This value returns your creditor id.
identification (optional)
String This value returns the descriptor for invoice and prepayment.
iban (optional)
String Iban of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Iban.
bic (optional)
String Bic of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer Bic.
externalOrderId (optional)
String External Order Id of installment transaction e.g: Hirepurchase, Installment-Secured.
zgReferenceId (optional)
String Reference Id of installment transaction e.g: Hirepurchase, Installment-Secured.
traceId (optional)
basketId (optional)
String Basket ID used for this transaction.
uniqueId (optional)
String Unique id of the payment system used.
shortId (optional)
String User-friendly reference id of the payment system.
descriptor (optional)
String Descriptor of the merchant for prepayment or invoice.
holder (optional)
String Holder of the merchant for prepayment or invoice. In the case of a direct debit, this value contains the customer holder.
PDFLink (optional)
String PDFLink of installment transaction e.g: Hirepurchase, Installment-Secured.
paypalBuyerId (optional)
String Id of buyer for Paypal transaction.
3dsEci (optional)
String 3dsEci flag from Payment Core.
participantId
String Only valid for marketplace payment: Channel Id(s) of marketplace's participant(s).
PaymentResponseResources
customerId (optional)
String Customer id used for this transaction.
paymentId (optional)
String Id of the payment.
basketId (optional)
String Basket ID used for this transaction.
metadataId (optional)
String Meta data ID used for this transaction.
payPageId (optional)
String Payment Page Id related to this payment.
linkPayId (optional)
typeId (optional)
String Id of the types Resource that is to be used for this transaction.
PrePaymentResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
PropertiesResponseModel
properties (optional)
Przelewy24ResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
RecurringRequest
amount (optional)
returnUrl (optional)
currency (optional)
resources (optional)
RecurringResponse
isSuccess (optional)
isPending (optional)
isError (optional)
redirectUrl (optional)
message (optional)
amount (optional)
currency (optional)
returnUrl (optional)
date (optional)
resources (optional)
processing (optional)
RetrieveEntity
numberOfRates (optional)
Long format: int64
dayOfPurchase (optional)
orderDate (optional)
totalPurchaseAmount (optional)
totalInterestAmount (optional)
totalAmount (optional)
effectiveInterestRate (optional)
nominalInterestRate (optional)
feeFirstRate (optional)
feePerRate (optional)
monthlyRate (optional)
lastRate (optional)
installmentRates (optional)
RetrieveInstallmentRate
date (optional)
numberOfInterest (optional)
amountOfRepayment (optional)
rate (optional)
totalRemainingAmount (optional)
timePassedInYears (optional)
type (optional)
rateIndex (optional)
accumulatedInterest (optional)
ultimo (optional)
SofortResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)
SupportResponse
brands (optional)
countries (optional)
channel (optional)
currency (optional)
UpdatedEmailCreditcard
email
WeChatPayResponseModel
id (optional)
method (optional)
recurring (optional)
customerId (optional)
geoLocation (optional)