PrepareDebitRequest

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "withRegister": true,
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "language": "st"
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	false	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
withRegister	boolean	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
language	string	false	none	none

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED

PrepareDebitResponse

{
  "success": true,
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
error	string	false	none	none

Debit

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "surchargeAmount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "splits": [
    {
      "identification": "string",
      "amount": "string",
      "currency": "string",
      "sellerMerchantGuid": "string",
      "sellerMerchantExternalId": "string",
      "commissionFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ],
  "withRegister": true,
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "payByLink": {
    "sendByEmail": true,
    "expirationInMinute": 1
  },
  "language": "st",
  "requestDcc": true,
  "dccData": {
    "remoteIdentifier": "string",
    "originalAmount": "string",
    "originalCurrency": "string",
    "convertedAmount": "string",
    "convertedCurrency": "string",
    "conversionRate": 0,
    "selectedCurrency": "string",
    "markUp": 0
  },
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  },
  "referenceSchemeTransactionIdentifier": "string",
  "includeTracing": true,
  "requestPartialAuthorization": true
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
amount	Amount	true	none	none
surchargeAmount	Amount	false	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
splits	Splits	false	none	none
withRegister	boolean	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
payByLink	PayByLink	false	none	none
language	string	false	none	none
requestDcc	boolean	false	none	none
dccData	DccData	false	none	none
l2l3Data	L2L3Data	false	none	none
referenceSchemeTransactionIdentifier	string	false	none	none
includeTracing	boolean	false	none	none
requestPartialAuthorization	boolean	false	none	Request a partial authorization when the full amount cannot be authorized. The actual authorized amount may be less than the requested amount. Available on: CheckoutCom, StripeExtended, WorldLine

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

PreparePreauthorizeRequest

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "withRegister": true,
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "language": "st"
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	false	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
withRegister	boolean	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
language	string	false	none	none

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED

PreparePreauthorizeResponse

{
  "success": true,
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
error	string	false	none	none

Preauthorize

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "captureInMinutes": 1,
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "surchargeAmount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "splits": [
    {
      "identification": "string",
      "amount": "string",
      "currency": "string",
      "sellerMerchantGuid": "string",
      "sellerMerchantExternalId": "string",
      "commissionFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ],
  "withRegister": true,
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "payByLink": {
    "sendByEmail": true,
    "expirationInMinute": 1
  },
  "language": "st",
  "requestDcc": true,
  "dccData": {
    "remoteIdentifier": "string",
    "originalAmount": "string",
    "originalCurrency": "string",
    "convertedAmount": "string",
    "convertedCurrency": "string",
    "conversionRate": 0,
    "selectedCurrency": "string",
    "markUp": 0
  },
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  },
  "referenceSchemeTransactionIdentifier": "string",
  "includeTracing": true,
  "requestPartialAuthorization": true
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
captureInMinutes	integer	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
amount	Amount	true	none	none
surchargeAmount	Amount	false	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
splits	Splits	false	none	none
withRegister	boolean	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
payByLink	PayByLink	false	none	none
language	string	false	none	none
requestDcc	boolean	false	none	none
dccData	DccData	false	none	none
l2l3Data	L2L3Data	false	none	none
referenceSchemeTransactionIdentifier	string	false	none	none
includeTracing	boolean	false	none	none
requestPartialAuthorization	boolean	false	none	Request a partial authorization when the full amount cannot be authorized. The actual authorized amount may be less than the requested amount. Available on: CheckoutCom, StripeExtended, WorldLine

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

IncrementalAuthorization

{
  "merchantTransactionId": "string",
  "referenceUuid": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "referenceSchemeLifecycleIdentifier": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "amount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "transactionIndicator": "SINGLE",
  "language": "st",
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
referenceUuid	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
referenceSchemeLifecycleIdentifier	string	false	none	none
extraData	ExtraData	false	none	none
merchantMetaData	string	false	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
transactionIndicator	string	false	none	none
language	string	false	none	none
l2l3Data	L2L3Data	false	none	none

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

Capture

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "currency": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "splits": [
    {
      "identification": "string",
      "amount": "string",
      "currency": "string",
      "sellerMerchantGuid": "string",
      "sellerMerchantExternalId": "string",
      "commissionFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ],
  "isFinalCapture": true,
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	true	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
description	string	false	none	none
items	Items	false	none	none
splits	Splits	false	none	none
isFinalCapture	boolean	false	none	none
l2l3Data	L2L3Data	false	none	none

Void

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "amount": "string",
  "currency": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	true	none	none
description	string	false	none	none

PrepareRegisterRequest

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "payByLink": {
    "sendByEmail": true,
    "expirationInMinute": 1
  },
  "language": "st",
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	false	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
payByLink	PayByLink	false	none	none
language	string	false	none	none
l2l3Data	L2L3Data	false	none	none

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

PrepareRegisterResponse

{
  "success": true,
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
error	string	false	none	none

Register

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "transactionIndicator": "SINGLE",
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "schedule": {
    "amount": "string",
    "currency": "string",
    "periodLength": 0,
    "periodUnit": "DAY",
    "startDateTime": "string",
    "merchantMetaData": "string",
    "callbackUrl": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "threeDSecureData": {
    "3dsecure": "OFF",
    "schemeId": "CB",
    "channel": "01",
    "authenticationIndicator": "01",
    "cardholderAuthenticationMethod": "01",
    "cardholderAuthenticationDateTime": "string",
    "cardHolderAuthenticationData": "string",
    "challengeIndicator": "01",
    "priorReference": "string",
    "priorAuthenticationMethod": "01",
    "priorAuthenticationDateTime": "string",
    "priorAuthenticationData": "string",
    "cardholderAccountType": "01",
    "cardholderAccountAgeIndicator": "01",
    "cardholderAccountDate": "string",
    "cardholderAccountChangeIndicator": "01",
    "cardholderAccountLastChange": "string",
    "cardholderAccountPasswordChangeIndicator": "01",
    "cardholderAccountLastPasswordChange": "string",
    "shippingAddressUsageIndicator": "01",
    "shippingAddressFirstUsage": "string",
    "transactionActivityDay": 0,
    "transactionActivityYear": 0,
    "addCardAttemptsDay": 0,
    "purchaseCountSixMonths": 0,
    "suspiciousAccountActivityIndicator": "01",
    "shippingNameEqualIndicator": "01",
    "paymentAccountAgeIndicator": "01",
    "paymentAccountAgeDate": "string",
    "billingAddressLine3": "string",
    "shippingAddressLine3": "string",
    "billingShippingAddressMatch": "Y",
    "homePhoneCountryPrefix": "str",
    "homePhoneNumber": "string",
    "mobilePhoneCountryPrefix": "str",
    "mobilePhoneNumber": "string",
    "workPhoneCountryPrefix": "str",
    "workPhoneNumber": "string",
    "purchaseInstalData": 1,
    "shipIndicator": "01",
    "deliveryTimeframe": "01",
    "deliveryEmailAddress": "string",
    "reorderItemsIndicator": "01",
    "preOrderPurchaseIndicator": "01",
    "preOrderDate": "string",
    "giftCardAmount": 0,
    "giftCardCurrency": "string",
    "giftCardCount": 1,
    "purchaseDate": "string",
    "recurringExpiry": "string",
    "recurringFrequency": 9999,
    "transType": "01",
    "exemptionIndicator": "01",
    "threeRIIndicator": "01",
    "browserChallengeWindowSize": "01",
    "browserAcceptHeader": "string",
    "browserIpAddress": "string",
    "browserJavaEnabled": true,
    "browserLanguage": "string",
    "browserColorDepth": 0,
    "browserScreenHeight": 0,
    "browserScreenWidth": 0,
    "browserTimezone": -9999,
    "browserUserAgent": "string",
    "browserPlatform": "string",
    "sdkInterface": "01",
    "sdkUiType": "string",
    "sdkAppID": "string",
    "sdkEncData": "string",
    "sdkEphemPubKey": "string",
    "sdkMaxTimeout": 5,
    "sdkReferenceNumber": "string",
    "sdkTransID": "string"
  },
  "payByLink": {
    "sendByEmail": true,
    "expirationInMinute": 1
  },
  "language": "st",
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  },
  "referenceUuid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
transactionIndicator	string	false	none	none
customer	Customer	false	none	none
schedule	Schedule	false	none	none
customerProfileData	CustomerProfileData	false	none	none
threeDSecureData	ThreeDSecureData	false	none	none
payByLink	PayByLink	false	none	none
language	string	false	none	none
l2l3Data	L2L3Data	false	none	none
referenceUuid	string	false	none	UUID of a previous register transaction on the same merchant. Used by the register-with-expiry-update flow to point at the existing token whose expiry date should be patched. When set together with extraData.expiryMonthUpdate / expiryYearUpdate, the request becomes a card-data-less expiry refresh — no PAN/CVV is required.

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	FIRST-CARDONFILE
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

Deregister

{
  "merchantTransactionId": "string",
  "transactionToken": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "tokenType": "ALL"
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
transactionToken	string	false	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
tokenType	string	false	none	none

Enumerated Values

Property	Value
tokenType	ALL
tokenType	PAN
tokenType	NT

Refund

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "referenceSchemeLifecycleIdentifier": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "currency": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "splits": [
    {
      "identification": "string",
      "amount": "string",
      "currency": "string",
      "sellerMerchantGuid": "string",
      "sellerMerchantExternalId": "string",
      "commissionFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ],
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
referenceSchemeLifecycleIdentifier	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	true	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
splits	Splits	false	none	none
l2l3Data	L2L3Data	false	none	none

Payout

{
  "merchantTransactionId": "string",
  "additionalId1": "string",
  "additionalId2": "string",
  "referenceSchemeLifecycleIdentifier": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "pspPassthroughData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "referenceUuid": "string",
  "amount": "string",
  "currency": "string",
  "successUrl": "string",
  "cancelUrl": "string",
  "errorUrl": "string",
  "callbackUrl": "string",
  "transactionToken": "string",
  "description": "string",
  "items": [
    {
      "identification": "string",
      "name": "string",
      "description": "string",
      "quantity": 1,
      "price": 0,
      "currency": "string",
      "l2l3Data": {
        "type": "string",
        "unit": "string",
        "unitPrice": "string",
        "discount": "string",
        "discountRate": "string",
        "shippingAmount": "string",
        "taxAmount": "string",
        "taxRate": "string",
        "commodityCode": "string",
        "taxDetails": [
          {
            "type": "string",
            "amount": "string",
            "rate": "string",
            "code": "string",
            "taxId": "string",
            "applied": "string",
            "exemptionCode": "string"
          }
        ]
      },
      "extraData": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "splits": [
    {
      "identification": "string",
      "amount": "string",
      "currency": "string",
      "sellerMerchantGuid": "string",
      "sellerMerchantExternalId": "string",
      "commissionFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ],
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "payByLink": {
    "sendByEmail": true,
    "expirationInMinute": 1
  },
  "language": "st",
  "transactionIndicator": "SINGLE",
  "l2l3Data": {
    "taxAmount": "string",
    "vatRegistrationNumber": "string",
    "nationalTaxIncluded": "string",
    "discountAmount": "string",
    "commodityCode": "string",
    "freightAmount": "string",
    "freightTaxAmount": "string",
    "dutyAmount": "string",
    "taxDetails": [
      {
        "type": "string",
        "amount": "string",
        "rate": "string",
        "code": "string",
        "taxId": "string",
        "applied": "string",
        "exemptionCode": "string"
      }
    ]
  },
  "includeTracing": true,
  "allowUnlinkedRefund": true
}

Properties

Name	Type	Required	Restrictions	Description
merchantTransactionId	string	true	none	none
additionalId1	string	false	none	none
additionalId2	string	false	none	none
referenceSchemeLifecycleIdentifier	string	false	none	none
extraData	ExtraData	false	none	none
pspPassthroughData	PspPassthroughData	false	none	none
merchantMetaData	string	false	none	none
referenceUuid	string	false	none	none
amount	Amount	true	none	none
currency	Currency	true	none	none
successUrl	string	false	none	none
cancelUrl	string	false	none	none
errorUrl	string	false	none	none
callbackUrl	string	false	none	none
transactionToken	string	false	none	none
description	string	false	none	none
items	Items	false	none	none
splits	Splits	false	none	none
customer	Customer	false	none	none
payByLink	PayByLink	false	none	none
language	string	false	none	none
transactionIndicator	string	false	none	none
l2l3Data	L2L3Data	false	none	none
includeTracing	boolean	false	none	none
allowUnlinkedRefund	boolean	false	none	When true, the payout is treated as an unlinked refund (a credit not tied to a prior debit transaction). Supported by select connectors only. Available on: Axepta, CheckoutCom, StripeExtended, WorldLine.

Enumerated Values

Property	Value
transactionIndicator	SINGLE
transactionIndicator	INITIAL
transactionIndicator	RECURRING
transactionIndicator	CARDONFILE
transactionIndicator	CARDONFILE-MERCHANT-INITIATED
transactionIndicator	MOTO

StartSchedule

{
  "registrationUuid": "string",
  "amount": "string",
  "currency": "string",
  "periodLength": 0,
  "periodUnit": "DAY",
  "startDateTime": "string",
  "merchantMetaData": "string",
  "callbackUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
registrationUuid	string	true	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
periodLength	number	false	none	none
periodUnit	string	false	none	none
startDateTime	DateTimeZone	false	none	none
merchantMetaData	string	false	none	none
callbackUrl	string	false	none	none

Enumerated Values

Property	Value
periodUnit	DAY
periodUnit	WEEK
periodUnit	MONTH
periodUnit	YEAR

UpdateSchedule

{
  "registrationUuid": "string",
  "amount": "string",
  "currency": "string",
  "periodLength": 0,
  "periodUnit": "DAY",
  "startDateTime": "string",
  "merchantMetaData": "string",
  "callbackUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
registrationUuid	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
periodLength	number	false	none	none
periodUnit	string	false	none	none
startDateTime	DateTimeZone	false	none	none
merchantMetaData	string	false	none	none
callbackUrl	string	false	none	none

Enumerated Values

Property	Value
periodUnit	DAY
periodUnit	WEEK
periodUnit	MONTH
periodUnit	YEAR

PauseSchedule

{}

Properties

None

ContinueSchedule

{
  "continueDateTime": "string"
}

Properties

Name	Type	Required	Restrictions	Description
continueDateTime	DateTimeZone	true	none	none

CancelSchedule

{}

Properties

None

OptionsRequest

{
  "parameters": {}
}

Properties

Name	Type	Required	Restrictions	Description
parameters	object	false	none	none

DisputeAcceptRequest

{
  "extraData": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
extraData	ExtraData	false	none	none

DisputeMetadataRequest

{
  "extraData": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
extraData	ExtraData	false	none	none

DisputeUploadEvidenceRequest

{
  "file": "string",
  "extraData": "string"
}

Properties

Name	Type	Required	Restrictions	Description
file	string(binary)	true	none	none
extraData	string	false	none	none
» additionalProperties	string	false	none	none

DisputeSubmitEvidenceRequest

{
  "extraData": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
extraData	ExtraData	false	none	none

DisputeResponseExtraData

{
  "someKey": "someValue",
  "otherKey": [
    {
      "otherKey1": "otherValue1",
      "otherKey2": "otherValue2"
    }
  ]
}

Object containing key-value pairs (string-to-string) or nested objects, returned by the Provider.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	none

DisputeResponseMetadata

{
  "someKey": "someValue",
  "otherKey": [
    {
      "otherKey1": "otherValue1",
      "otherKey2": "otherValue2"
    }
  ]
}

Object containing key-value pairs (string-to-string) or nested objects, returned by the Provider.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	none

ScheduleResponse

{
  "success": true,
  "scheduleId": "string",
  "registrationId": "string",
  "oldStatus": "ACTIVE",
  "newStatus": "ACTIVE",
  "scheduledAt": "string",
  "merchantMetaData": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
scheduleId	string	false	none	none
registrationId	string	false	none	none
oldStatus	ScheduleStatus	false	none	none
newStatus	ScheduleStatus	false	none	none
scheduledAt	DateTimeZone	false	none	none
merchantMetaData	string	false	none	none

StatusResponse

{
  "success": true,
  "transactionStatus": "SUCCESS",
  "uuid": "string",
  "merchantTransactionId": "string",
  "purchaseId": "string",
  "transactionType": "DEBIT",
  "transactionSubType": "cb-resolved",
  "paymentMethod": "string",
  "amount": "string",
  "currency": "string",
  "surchargeAmount": "string",
  "totalAmount": "string",
  "schedules": {
    "property1": {
      "scheduleId": "string",
      "scheduleStatus": "ACTIVE",
      "scheduledAt": "string",
      "merchantMetaData": "string"
    },
    "property2": {
      "scheduleId": "string",
      "scheduleStatus": "ACTIVE",
      "scheduledAt": "string",
      "merchantMetaData": "string"
    }
  },
  "errors": [
    {
      "message": "string",
      "code": 0,
      "adapterMessage": "string",
      "adapterCode": "string"
    }
  ],
  "chargebackData": {
    "originalUuid": "string",
    "originalMerchantTransactionId": "string",
    "amount": "string",
    "currency": "string",
    "reason": "string",
    "chargebackDateTime": "string",
    "disputeData": {
      "adapterDisputeId": "string",
      "status": "string",
      "reasonText": "string",
      "reasonCode": "string",
      "metaData": "string",
      "createdAt": "string",
      "modifiedAt": "string"
    }
  },
  "chargebackReversalData": {
    "originalUuid": "string",
    "originalMerchantTransactionId": "string",
    "chargebackUuid": "string",
    "amount": "string",
    "currency": "string",
    "reason": "string",
    "reversalDateTime": "string"
  },
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "returnData": {
    "_TYPE": "cardData",
    "type": "string",
    "firstName": "string",
    "lastName": "string",
    "country": "string",
    "cardHolder": "string",
    "expiryMonth": "string",
    "expiryYear": "string",
    "binDigits": "string",
    "firstSixDigits": "string",
    "lastFourDigits": "string",
    "fingerprint": "string",
    "binBrand": "string",
    "binBank": "string",
    "binType": "string",
    "binLevel": "string",
    "binCountry": "string",
    "binSegment": "Consumer",
    "binRawData": {
      "type": "string",
      "data": {}
    },
    "threeDSecure": "string",
    "eci": "string",
    "merchantAdviceCode": "string",
    "parsedMerchantAdviceCode": "string",
    "schemeTransactionIdentifier": "string",
    "schemeLifecycleIdentifier": "string",
    "referenceSchemeLifecycleIdentifier": "string",
    "cardUpdateStatus": "updated",
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  },
  "payByLinkData": {
    "payByLink": true,
    "sendViaEmail": true
  },
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "tracingData": {
    "transactions": [
      {
        "uuid": "string",
        "sequence_number": "string",
        "status": "string",
        "connector": {
          "guid": "string",
          "adapter_name": "string",
          "brand": "string"
        }
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
transactionStatus	TransactionStatus	false	none	none
uuid	string	false	none	none
merchantTransactionId	string	false	none	none
purchaseId	string	false	none	none
transactionType	TransactionType	false	none	none
transactionSubType	TransactionSubType	false	none	Only present if transaction has a subType
paymentMethod	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
surchargeAmount	Amount	false	none	Only present if surcharge was applied
totalAmount	Amount	false	none	Only present if surcharge was applied
schedules	object	false	none	none
» additionalProperties	ScheduleData	false	none	none
errors	TransactionErrors	false	none	none
chargebackData	ChargebackData	false	none	none
chargebackReversalData	ChargebackReversalData	false	none	none
extraData	ExtraData	false	none	none
merchantMetaData	string	false	none	none
returnData	ReturnData	false	none	none
payByLinkData	PayByLinkData	false	none	none
customer	Customer	false	none	none
customerProfileData	CustomerProfileData	false	none	none
tracingData	TracingData	false	none	Present only if tracing was enabled in request

OptionsResponse

{
  "success": true,
  "options": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "error": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
options	[object]	false	none	none
» key	string	false	none	none
» value	string	false	none	none
error	string	false	none	none

DisputeResponse

{
  "success": true,
  "extraData": {
    "someKey": "someValue",
    "otherKey": [
      {
        "otherKey1": "otherValue1",
        "otherKey2": "otherValue2"
      }
    ]
  },
  "errors": [
    {
      "message": "string",
      "code": 0,
      "adapterMessage": "string",
      "adapterCode": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
extraData	DisputeResponseExtraData	false	none	Object containing key-value pairs (string-to-string) or nested objects, returned by the Provider.
errors	TransactionErrors	false	none	none

DisputeMetadataResponse

{
  "success": true,
  "extraData": {
    "someKey": "someValue",
    "otherKey": [
      {
        "otherKey1": "otherValue1",
        "otherKey2": "otherValue2"
      }
    ]
  },
  "metaData": {
    "someKey": "someValue",
    "otherKey": [
      {
        "otherKey1": "otherValue1",
        "otherKey2": "otherValue2"
      }
    ]
  },
  "errors": [
    {
      "message": "string",
      "code": 0,
      "adapterMessage": "string",
      "adapterCode": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
extraData	DisputeResponseExtraData	false	none	Object containing key-value pairs (string-to-string) or nested objects, returned by the Provider.
metaData	DisputeResponseMetadata	false	none	Object containing key-value pairs (string-to-string) or nested objects, returned by the Provider.
errors	TransactionErrors	false	none	none

Amount

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Currency

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Country

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

DateTimeZone

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

DateTime

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Date

"string"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

L2L3Data

{
  "taxAmount": "string",
  "vatRegistrationNumber": "string",
  "nationalTaxIncluded": "string",
  "discountAmount": "string",
  "commodityCode": "string",
  "freightAmount": "string",
  "freightTaxAmount": "string",
  "dutyAmount": "string",
  "taxDetails": [
    {
      "type": "string",
      "amount": "string",
      "rate": "string",
      "code": "string",
      "taxId": "string",
      "applied": "string",
      "exemptionCode": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
taxAmount	Amount	false	none	none
vatRegistrationNumber	string	false	none	none
nationalTaxIncluded	string	false	none	none
discountAmount	Amount	false	none	none
commodityCode	string	false	none	none
freightAmount	Amount	false	none	none
freightTaxAmount	Amount	false	none	none
dutyAmount	Amount	false	none	none
taxDetails	TaxDetails	false	none	none

TaxDetails

[
  {
    "type": "string",
    "amount": "string",
    "rate": "string",
    "code": "string",
    "taxId": "string",
    "applied": "string",
    "exemptionCode": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
amount	Amount	false	none	none
rate	Amount	false	none	none
code	string	false	none	none
taxId	string	false	none	none
applied	string	false	none	none
exemptionCode	string	false	none	none

ExtraData

{
  "property1": "string",
  "property2": "string"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	none

PspPassthroughData

{
  "property1": "string",
  "property2": "string"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	none

Items

[
  {
    "identification": "string",
    "name": "string",
    "description": "string",
    "quantity": 1,
    "price": 0,
    "currency": "string",
    "l2l3Data": {
      "type": "string",
      "unit": "string",
      "unitPrice": "string",
      "discount": "string",
      "discountRate": "string",
      "shippingAmount": "string",
      "taxAmount": "string",
      "taxRate": "string",
      "commodityCode": "string",
      "taxDetails": [
        {
          "type": "string",
          "amount": "string",
          "rate": "string",
          "code": "string",
          "taxId": "string",
          "applied": "string",
          "exemptionCode": "string"
        }
      ]
    },
    "extraData": {
      "property1": "string",
      "property2": "string"
    }
  }
]

Properties

Name	Type	Required	Restrictions	Description
identification	string	false	none	none
name	string	false	none	none
description	string	false	none	none
quantity	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
price	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
currency	Currency	false	none	none
l2l3Data	object	false	none	none
» type	string	false	none	none
» unit	string	false	none	none
» unitPrice	Amount	false	none	none
» discount	Amount	false	none	none
» discountRate	Amount	false	none	none
» shippingAmount	Amount	false	none	none
» taxAmount	Amount	false	none	none
» taxRate	Amount	false	none	none
» commodityCode	string	false	none	none
» taxDetails	TaxDetails	false	none	none
extraData	ExtraData	false	none	none

Splits

[
  {
    "identification": "string",
    "amount": "string",
    "currency": "string",
    "sellerMerchantGuid": "string",
    "sellerMerchantExternalId": "string",
    "commissionFee": {
      "amount": "string",
      "currency": "string"
    }
  }
]

Properties

Name	Type	Required	Restrictions	Description
identification	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
sellerMerchantGuid	string	false	none	none
sellerMerchantExternalId	string	false	none	none
commissionFee	object	false	none	none
» amount	Amount	false	none	none
» currency	Currency	false	none	none

PaymentData

{
  "ibanData": {
    "iban": "string",
    "bic": "string",
    "mandateId": "string",
    "mandateDate": "string"
  }
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	IbanData	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	WalletData	false	none	none

IbanData

{
  "ibanData": {
    "iban": "string",
    "bic": "string",
    "mandateId": "string",
    "mandateDate": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
ibanData	object	false	none	none
» iban	string	false	none	none
» bic	string	false	none	none
» mandateId	string	false	none	none
» mandateDate	Date	false	none	none

WalletData

{
  "walletData": {
    "walletReferenceId": "string",
    "walletOwner": "string",
    "walletType": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
walletData	object	false	none	none
» walletReferenceId	string	false	none	none
» walletOwner	string	false	none	none
» walletType	string	false	none	none

ThreeDSecureData

{
  "3dsecure": "OFF",
  "schemeId": "CB",
  "channel": "01",
  "authenticationIndicator": "01",
  "cardholderAuthenticationMethod": "01",
  "cardholderAuthenticationDateTime": "string",
  "cardHolderAuthenticationData": "string",
  "challengeIndicator": "01",
  "priorReference": "string",
  "priorAuthenticationMethod": "01",
  "priorAuthenticationDateTime": "string",
  "priorAuthenticationData": "string",
  "cardholderAccountType": "01",
  "cardholderAccountAgeIndicator": "01",
  "cardholderAccountDate": "string",
  "cardholderAccountChangeIndicator": "01",
  "cardholderAccountLastChange": "string",
  "cardholderAccountPasswordChangeIndicator": "01",
  "cardholderAccountLastPasswordChange": "string",
  "shippingAddressUsageIndicator": "01",
  "shippingAddressFirstUsage": "string",
  "transactionActivityDay": 0,
  "transactionActivityYear": 0,
  "addCardAttemptsDay": 0,
  "purchaseCountSixMonths": 0,
  "suspiciousAccountActivityIndicator": "01",
  "shippingNameEqualIndicator": "01",
  "paymentAccountAgeIndicator": "01",
  "paymentAccountAgeDate": "string",
  "billingAddressLine3": "string",
  "shippingAddressLine3": "string",
  "billingShippingAddressMatch": "Y",
  "homePhoneCountryPrefix": "str",
  "homePhoneNumber": "string",
  "mobilePhoneCountryPrefix": "str",
  "mobilePhoneNumber": "string",
  "workPhoneCountryPrefix": "str",
  "workPhoneNumber": "string",
  "purchaseInstalData": 1,
  "shipIndicator": "01",
  "deliveryTimeframe": "01",
  "deliveryEmailAddress": "string",
  "reorderItemsIndicator": "01",
  "preOrderPurchaseIndicator": "01",
  "preOrderDate": "string",
  "giftCardAmount": 0,
  "giftCardCurrency": "string",
  "giftCardCount": 1,
  "purchaseDate": "string",
  "recurringExpiry": "string",
  "recurringFrequency": 9999,
  "transType": "01",
  "exemptionIndicator": "01",
  "threeRIIndicator": "01",
  "browserChallengeWindowSize": "01",
  "browserAcceptHeader": "string",
  "browserIpAddress": "string",
  "browserJavaEnabled": true,
  "browserLanguage": "string",
  "browserColorDepth": 0,
  "browserScreenHeight": 0,
  "browserScreenWidth": 0,
  "browserTimezone": -9999,
  "browserUserAgent": "string",
  "browserPlatform": "string",
  "sdkInterface": "01",
  "sdkUiType": "string",
  "sdkAppID": "string",
  "sdkEncData": "string",
  "sdkEphemPubKey": "string",
  "sdkMaxTimeout": 5,
  "sdkReferenceNumber": "string",
  "sdkTransID": "string"
}

Properties

Name	Type	Required	Restrictions	Description
3dsecure	string	false	none	none
schemeId	string	false	none	none
channel	string	false	none	none
authenticationIndicator	string	false	none	none
cardholderAuthenticationMethod	string	false	none	none
cardholderAuthenticationDateTime	DateTime	false	none	none
cardHolderAuthenticationData	string	false	none	none
challengeIndicator	string	false	none	none
priorReference	string	false	none	none
priorAuthenticationMethod	string	false	none	none
priorAuthenticationDateTime	DateTime	false	none	none
priorAuthenticationData	string	false	none	none
cardholderAccountType	string	false	none	none
cardholderAccountAgeIndicator	string	false	none	none
cardholderAccountDate	Date	false	none	none
cardholderAccountChangeIndicator	string	false	none	none
cardholderAccountLastChange	Date	false	none	none
cardholderAccountPasswordChangeIndicator	string	false	none	none
cardholderAccountLastPasswordChange	Date	false	none	none
shippingAddressUsageIndicator	string	false	none	none
shippingAddressFirstUsage	Date	false	none	none
transactionActivityDay	number	false	none	none
transactionActivityYear	number	false	none	none
addCardAttemptsDay	number	false	none	none
purchaseCountSixMonths	number	false	none	none
suspiciousAccountActivityIndicator	string	false	none	none
shippingNameEqualIndicator	string	false	none	none
paymentAccountAgeIndicator	string	false	none	none
paymentAccountAgeDate	Date	false	none	none
billingAddressLine3	string	false	none	none
shippingAddressLine3	string	false	none	none
billingShippingAddressMatch	string	false	none	none
homePhoneCountryPrefix	string	false	none	none
homePhoneNumber	string	false	none	none
mobilePhoneCountryPrefix	string	false	none	none
mobilePhoneNumber	string	false	none	none
workPhoneCountryPrefix	string	false	none	none
workPhoneNumber	string	false	none	none
purchaseInstalData	number	false	none	none
shipIndicator	string	false	none	none
deliveryTimeframe	string	false	none	none
deliveryEmailAddress	string	false	none	none
reorderItemsIndicator	string	false	none	none
preOrderPurchaseIndicator	string	false	none	none
preOrderDate	Date	false	none	none
giftCardAmount	number	false	none	none
giftCardCurrency	Currency	false	none	none
giftCardCount	number	false	none	none
purchaseDate	DateTime	false	none	none
recurringExpiry	Date	false	none	none
recurringFrequency	number	false	none	none
transType	string	false	none	none
exemptionIndicator	string	false	none	none
threeRIIndicator	string	false	none	none
browserChallengeWindowSize	string	false	none	none
browserAcceptHeader	string	false	none	none
browserIpAddress	string	false	none	none
browserJavaEnabled	boolean	false	none	none
browserLanguage	string	false	none	none
browserColorDepth	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
browserScreenHeight	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
browserScreenWidth	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
browserTimezone	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
browserUserAgent	string	false	none	none
browserPlatform	string	false	none	none
sdkInterface	string	false	none	none
sdkUiType	string	false	none	none
sdkAppID	string	false	none	none
sdkEncData	string	false	none	none
sdkEphemPubKey	string	false	none	none
sdkMaxTimeout	number	false	none	none
sdkReferenceNumber	string	false	none	none
sdkTransID	string	false	none	none

Enumerated Values

Property	Value
3dsecure	OFF
3dsecure	OPTIONAL
3dsecure	MANDATORY
schemeId	CB
schemeId	Eftpos
channel	01
channel	02
channel	03
authenticationIndicator	01
authenticationIndicator	02
authenticationIndicator	03
authenticationIndicator	04
authenticationIndicator	05
authenticationIndicator	06
cardholderAuthenticationMethod	01
cardholderAuthenticationMethod	02
cardholderAuthenticationMethod	03
cardholderAuthenticationMethod	04
cardholderAuthenticationMethod	05
cardholderAuthenticationMethod	06
challengeIndicator	01
challengeIndicator	02
challengeIndicator	03
challengeIndicator	04
challengeIndicator	05
challengeIndicator	06
challengeIndicator	07
challengeIndicator	08
challengeIndicator	09
priorAuthenticationMethod	01
priorAuthenticationMethod	02
priorAuthenticationMethod	03
priorAuthenticationMethod	04
cardholderAccountType	01
cardholderAccountType	02
cardholderAccountType	03
cardholderAccountType	04
cardholderAccountAgeIndicator	01
cardholderAccountAgeIndicator	02
cardholderAccountAgeIndicator	03
cardholderAccountAgeIndicator	04
cardholderAccountAgeIndicator	05
cardholderAccountChangeIndicator	01
cardholderAccountChangeIndicator	02
cardholderAccountChangeIndicator	03
cardholderAccountChangeIndicator	04
cardholderAccountPasswordChangeIndicator	01
cardholderAccountPasswordChangeIndicator	02
cardholderAccountPasswordChangeIndicator	03
cardholderAccountPasswordChangeIndicator	04
cardholderAccountPasswordChangeIndicator	05
shippingAddressUsageIndicator	01
shippingAddressUsageIndicator	02
shippingAddressUsageIndicator	03
shippingAddressUsageIndicator	04
suspiciousAccountActivityIndicator	01
suspiciousAccountActivityIndicator	02
shippingNameEqualIndicator	01
shippingNameEqualIndicator	02
paymentAccountAgeIndicator	01
paymentAccountAgeIndicator	02
paymentAccountAgeIndicator	03
paymentAccountAgeIndicator	04
paymentAccountAgeIndicator	05
billingShippingAddressMatch	Y
billingShippingAddressMatch	N
shipIndicator	01
shipIndicator	02
shipIndicator	03
shipIndicator	04
shipIndicator	05
shipIndicator	06
shipIndicator	07
deliveryTimeframe	01
deliveryTimeframe	02
deliveryTimeframe	03
deliveryTimeframe	04
reorderItemsIndicator	01
reorderItemsIndicator	02
preOrderPurchaseIndicator	01
preOrderPurchaseIndicator	02
transType	01
transType	03
transType	10
transType	11
transType	28
exemptionIndicator	01
exemptionIndicator	02
exemptionIndicator	03
exemptionIndicator	04
exemptionIndicator	05
exemptionIndicator	06
exemptionIndicator	07
threeRIIndicator	01
threeRIIndicator	02
threeRIIndicator	03
threeRIIndicator	04
threeRIIndicator	05
threeRIIndicator	06
threeRIIndicator	07
threeRIIndicator	08
threeRIIndicator	09
threeRIIndicator	10
threeRIIndicator	11
threeRIIndicator	12
browserChallengeWindowSize	01
browserChallengeWindowSize	02
browserChallengeWindowSize	03
browserChallengeWindowSize	04
browserChallengeWindowSize	05
anonymous	1
anonymous	4
anonymous	8
anonymous	15
anonymous	16
anonymous	24
anonymous	30
anonymous	32
anonymous	48
sdkInterface	01
sdkInterface	02
sdkInterface	03

ChargebackData

{
  "originalUuid": "string",
  "originalMerchantTransactionId": "string",
  "amount": "string",
  "currency": "string",
  "reason": "string",
  "chargebackDateTime": "string",
  "disputeData": {
    "adapterDisputeId": "string",
    "status": "string",
    "reasonText": "string",
    "reasonCode": "string",
    "metaData": "string",
    "createdAt": "string",
    "modifiedAt": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
originalUuid	string	false	none	none
originalMerchantTransactionId	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
reason	string	false	none	none
chargebackDateTime	DateTimeZone	false	none	none
disputeData	TransactionDisputeData	false	none	none

ChargebackReversalData

{
  "originalUuid": "string",
  "originalMerchantTransactionId": "string",
  "chargebackUuid": "string",
  "amount": "string",
  "currency": "string",
  "reason": "string",
  "reversalDateTime": "string"
}

Properties

Name	Type	Required	Restrictions	Description
originalUuid	string	false	none	none
originalMerchantTransactionId	string	false	none	none
chargebackUuid	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
reason	string	false	none	none
reversalDateTime	DateTimeZone	false	none	none

TracingData

{
  "transactions": [
    {
      "uuid": "string",
      "sequence_number": "string",
      "status": "string",
      "connector": {
        "guid": "string",
        "adapter_name": "string",
        "brand": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
transactions	[object]	false	none	none
» uuid	string	false	none	none
» sequence_number	string	false	none	none
» status	string	false	none	none
» connector	object	false	none	none
»» guid	string	false	none	none
»» adapter_name	string	false	none	none
»» brand	string	false	none	none

TransactionDisputeData

{
  "adapterDisputeId": "string",
  "status": "string",
  "reasonText": "string",
  "reasonCode": "string",
  "metaData": "string",
  "createdAt": "string",
  "modifiedAt": "string"
}

Properties

Name	Type	Required	Restrictions	Description
adapterDisputeId	string	false	none	none
status	string	false	none	none
reasonText	string	false	none	none
reasonCode	string	false	none	none
metaData	string	false	none	none
createdAt	DateTimeZone	false	none	none
modifiedAt	DateTimeZone	false	none	none

Schedule

{
  "amount": "string",
  "currency": "string",
  "periodLength": 0,
  "periodUnit": "DAY",
  "startDateTime": "string",
  "merchantMetaData": "string",
  "callbackUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
amount	Amount	true	none	none
currency	Currency	true	none	none
periodLength	integer	true	none	none
periodUnit	string	true	none	none
startDateTime	DateTimeZone	false	none	none
merchantMetaData	string	false	none	none
callbackUrl	string	false	none	none

Enumerated Values

Property	Value
periodUnit	DAY
periodUnit	WEEK
periodUnit	MONTH
periodUnit	YEAR

ScheduleData

{
  "scheduleId": "string",
  "scheduleStatus": "ACTIVE",
  "scheduledAt": "string",
  "merchantMetaData": "string"
}

Properties

Name	Type	Required	Restrictions	Description
scheduleId	string	false	none	none
scheduleStatus	ScheduleStatus	false	none	none
scheduledAt	DateTimeZone	false	none	none
merchantMetaData	string	false	none	none

ContinueDcc

{
  "continueDccUuid": "string",
  "selectedDccCurrency": "string"
}

Properties

Name	Type	Required	Restrictions	Description
continueDccUuid	string	false	none	none
selectedDccCurrency	Currency	false	none	none

ScheduleStatus

"ACTIVE"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	ACTIVE
anonymous	PAUSED
anonymous	CANCELLED
anonymous	ERROR
anonymous	CREATE-PENDING

Customer

{
  "identification": "string",
  "firstName": "string",
  "lastName": "string",
  "birthDate": "string",
  "gender": "M",
  "billingAddress1": "string",
  "billingAddress2": "string",
  "billingCity": "string",
  "billingPostcode": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPhone": "string",
  "shippingFirstName": "string",
  "shippingLastName": "string",
  "shippingCompany": "string",
  "shippingAddress1": "string",
  "shippingAddress2": "string",
  "shippingCity": "string",
  "shippingPostcode": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPhone": "string",
  "company": "string",
  "email": "string",
  "emailVerified": true,
  "ipAddress": "string",
  "nationalId": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "paymentData": {
    "ibanData": {
      "iban": "string",
      "bic": "string",
      "mandateId": "string",
      "mandateDate": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
identification	string	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
birthDate	Date	false	none	none
gender	string	false	none	none
billingAddress1	string	false	none	none
billingAddress2	string	false	none	none
billingCity	string	false	none	none
billingPostcode	string	false	none	none
billingState	string	false	none	none
billingCountry	Country	false	none	none
billingPhone	string	false	none	none
shippingFirstName	string	false	none	none
shippingLastName	string	false	none	none
shippingCompany	string	false	none	none
shippingAddress1	string	false	none	none
shippingAddress2	string	false	none	none
shippingCity	string	false	none	none
shippingPostcode	string	false	none	none
shippingState	string	false	none	none
shippingCountry	Country	false	none	none
shippingPhone	string	false	none	none
company	string	false	none	none
email	string	false	none	none
emailVerified	boolean	false	none	none
ipAddress	string	false	none	none
nationalId	string	false	none	none
extraData	ExtraData	false	none	none
paymentData	PaymentData	false	none	none

Enumerated Values

Property	Value
gender	M
gender	F

CustomerProfileData

{
  "profileGuid": "string",
  "customerIdentification": "string",
  "paymentToken": "string",
  "markAsPreferred": true
}

Properties

Name	Type	Required	Restrictions	Description
profileGuid	string	false	none	none
customerIdentification	string	false	none	none
paymentToken	string	false	none	none
markAsPreferred	boolean	false	none	none

DccData

{
  "remoteIdentifier": "string",
  "originalAmount": "string",
  "originalCurrency": "string",
  "convertedAmount": "string",
  "convertedCurrency": "string",
  "conversionRate": 0,
  "selectedCurrency": "string",
  "markUp": 0
}

Properties

Name	Type	Required	Restrictions	Description
remoteIdentifier	string	false	none	none
originalAmount	Amount	false	none	none
originalCurrency	Currency	false	none	none
convertedAmount	Amount	false	none	none
convertedCurrency	Currency	false	none	none
conversionRate	number	false	none	none
selectedCurrency	string	false	none	none
markUp	number	false	none	none

TransactionResponse

{
  "success": true,
  "uuid": "string",
  "purchaseId": "string",
  "returnType": "FINISHED",
  "redirectType": "iframe",
  "redirectUrl": "string",
  "redirectQRCode": "string",
  "htmlContent": "string",
  "paymentDescriptor": "string",
  "paymentMethod": "string",
  "returnData": {
    "_TYPE": "cardData",
    "type": "string",
    "firstName": "string",
    "lastName": "string",
    "country": "string",
    "cardHolder": "string",
    "expiryMonth": "string",
    "expiryYear": "string",
    "binDigits": "string",
    "firstSixDigits": "string",
    "lastFourDigits": "string",
    "fingerprint": "string",
    "binBrand": "string",
    "binBank": "string",
    "binType": "string",
    "binLevel": "string",
    "binCountry": "string",
    "binSegment": "Consumer",
    "binRawData": {
      "type": "string",
      "data": {}
    },
    "threeDSecure": "string",
    "eci": "string",
    "merchantAdviceCode": "string",
    "parsedMerchantAdviceCode": "string",
    "schemeTransactionIdentifier": "string",
    "schemeLifecycleIdentifier": "string",
    "referenceSchemeLifecycleIdentifier": "string",
    "cardUpdateStatus": "updated",
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  },
  "scheduleData": {
    "scheduleId": "string",
    "scheduleStatus": "ACTIVE",
    "scheduledAt": "string",
    "merchantMetaData": "string"
  },
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "riskCheckData": {
    "riskCheckResult": "APPROVED",
    "riskScore": 0,
    "threeDSecureRequired": true
  },
  "errors": [
    {
      "errorMessage": "string",
      "errorCode": 0,
      "adapterMessage": "string",
      "adapterCode": "string"
    }
  ],
  "adapterMessage": "string",
  "adapterCode": "string",
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "dccData": {
    "uuid": "string",
    "originalAmount": "string",
    "originalCurrency": "string",
    "convertedAmount": "string",
    "convertedCurrency": "string",
    "conversionRate": 0,
    "disclaimer": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
uuid	string	false	none	none
purchaseId	string	false	none	none
returnType	string	false	none	none
redirectType	string	false	none	none
redirectUrl	string	false	none	none
redirectQRCode	string	false	none	DataUrl
htmlContent	string	false	none	none
paymentDescriptor	string	false	none	none
paymentMethod	string	false	none	none
returnData	ReturnData	false	none	none
scheduleData	ScheduleData	false	none	none
customerProfileData	CustomerProfileData	false	none	none
riskCheckData	object	false	none	none
» riskCheckResult	string	false	none	none
» riskScore	number	false	none	none
» threeDSecureRequired	boolean	false	none	none
errors	[object]	false	none	none
» errorMessage	string	false	none	none
» errorCode	integer(int32)	false	none	none
» adapterMessage	string	false	none	none
» adapterCode	string	false	none	none
adapterMessage	string	false	none	none
adapterCode	string	false	none	none
extraData	ExtraData	false	none	none
dccData	object	false	none	none
» uuid	string	false	none	none
» originalAmount	Amount	false	none	none
» originalCurrency	Currency	false	none	none
» convertedAmount	Amount	false	none	none
» convertedCurrency	Currency	false	none	none
» conversionRate	number	false	none	none
» disclaimer	string	false	none	none

Enumerated Values

Property	Value
returnType	FINISHED
returnType	REDIRECT
returnType	HTML
returnType	PENDING
returnType	ERROR
returnType	PENDING_DCC
redirectType	iframe
redirectType	fullpage
redirectType	3ds
riskCheckResult	APPROVED
riskCheckResult	DECLINED
riskCheckResult	REVIEW

PayByLinkData

{
  "payByLink": true,
  "sendViaEmail": true
}

Properties

Name	Type	Required	Restrictions	Description
payByLink	boolean	false	none	none
sendViaEmail	boolean	false	none	none

ReturnData

{
  "_TYPE": "cardData",
  "type": "string",
  "firstName": "string",
  "lastName": "string",
  "country": "string",
  "cardHolder": "string",
  "expiryMonth": "string",
  "expiryYear": "string",
  "binDigits": "string",
  "firstSixDigits": "string",
  "lastFourDigits": "string",
  "fingerprint": "string",
  "binBrand": "string",
  "binBank": "string",
  "binType": "string",
  "binLevel": "string",
  "binCountry": "string",
  "binSegment": "Consumer",
  "binRawData": {
    "type": "string",
    "data": {}
  },
  "threeDSecure": "string",
  "eci": "string",
  "merchantAdviceCode": "string",
  "parsedMerchantAdviceCode": "string",
  "schemeTransactionIdentifier": "string",
  "schemeLifecycleIdentifier": "string",
  "referenceSchemeLifecycleIdentifier": "string",
  "cardUpdateStatus": "updated",
  "cardUpdatedAt": "2024-05-07 00:00:00",
  "cardUpdatePausedUntil": "2024-05-07"
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	ReturnCardData	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	ReturnPhoneData	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	ReturnIbanData	false	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	ReturnWalletData	false	none	none

ReturnCardData

{
  "_TYPE": "cardData",
  "type": "string",
  "firstName": "string",
  "lastName": "string",
  "country": "string",
  "cardHolder": "string",
  "expiryMonth": "string",
  "expiryYear": "string",
  "binDigits": "string",
  "firstSixDigits": "string",
  "lastFourDigits": "string",
  "fingerprint": "string",
  "binBrand": "string",
  "binBank": "string",
  "binType": "string",
  "binLevel": "string",
  "binCountry": "string",
  "binSegment": "Consumer",
  "binRawData": {
    "type": "string",
    "data": {}
  },
  "threeDSecure": "string",
  "eci": "string",
  "merchantAdviceCode": "string",
  "parsedMerchantAdviceCode": "string",
  "schemeTransactionIdentifier": "string",
  "schemeLifecycleIdentifier": "string",
  "referenceSchemeLifecycleIdentifier": "string",
  "cardUpdateStatus": "updated",
  "cardUpdatedAt": "2024-05-07 00:00:00",
  "cardUpdatePausedUntil": "2024-05-07"
}

Properties

Name	Type	Required	Restrictions	Description
_TYPE	string	false	none	none
type	string	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
country	Country	false	none	none
cardHolder	string	false	none	none
expiryMonth	string	false	none	none
expiryYear	string	false	none	none
binDigits	string	false	none	none
firstSixDigits	string	false	none	none
lastFourDigits	string	false	none	none
fingerprint	string	false	none	none
binBrand	string	false	none	none
binBank	string	false	none	none
binType	string	false	none	none
binLevel	string	false	none	none
binCountry	string	false	none	none
binSegment	string	false	none	none
binRawData	object	false	none	none
» type	string	false	none	none
» data	object	false	none	none
threeDSecure	string	false	none	none
eci	string	false	none	none
merchantAdviceCode	string	false	none	none
parsedMerchantAdviceCode	string	false	none	none
schemeTransactionIdentifier	string	false	none	none
schemeLifecycleIdentifier	string	false	none	none
referenceSchemeLifecycleIdentifier	string	false	none	none
cardUpdateStatus	string	false	none	Account updater transaction status
cardUpdatedAt	string(date)	false	none	Last run of the batch
cardUpdatePausedUntil	string(date)	false	none	Updates paused until this date

Enumerated Values

Property	Value
_TYPE	cardData
binSegment	Consumer
binSegment	Business
binSegment	Commercial
binSegment	Government
binSegment	Unknown
cardUpdateStatus	updated
cardUpdateStatus	contact
cardUpdateStatus	new-expiry
cardUpdateStatus	closed

ReturnPhoneData

{
  "_TYPE": "phoneData",
  "phoneNumber": "string",
  "country": "string",
  "operator": "string"
}

Properties

Name	Type	Required	Restrictions	Description
_TYPE	string	false	none	none
phoneNumber	string	false	none	none
country	Country	false	none	none
operator	string	false	none	none

Enumerated Values

Property	Value
_TYPE	phoneData

ReturnIbanData

{
  "_TYPE": "ibanData",
  "accountOwner": "string",
  "iban": "string",
  "bic": "string",
  "mandateId": "string",
  "mandateDate": "string",
  "bankName": "string",
  "bankBranchName": "string",
  "country": "string"
}

Properties

Name	Type	Required	Restrictions	Description
_TYPE	string	false	none	none
accountOwner	string	false	none	none
iban	string	false	none	none
bic	string	false	none	none
mandateId	string	false	none	none
mandateDate	Date	false	none	none
bankName	string	false	none	none
bankBranchName	string	false	none	none
country	Country	false	none	none

Enumerated Values

Property	Value
_TYPE	ibanData

ReturnWalletData

{
  "_TYPE": "walletData",
  "walletReferenceId": "string",
  "walletOwner": "string",
  "walletType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
_TYPE	string	false	none	none
walletReferenceId	string	false	none	none
walletOwner	string	false	none	none
walletType	string	false	none	none

Enumerated Values

Property	Value
_TYPE	walletData

TransactionErrors

[
  {
    "message": "string",
    "code": 0,
    "adapterMessage": "string",
    "adapterCode": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[TransactionError]	false	none	none

TransactionError

{
  "message": "string",
  "code": 0,
  "adapterMessage": "string",
  "adapterCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none
code	integer(int32)	false	none	none
adapterMessage	string	false	none	none
adapterCode	string	false	none	none

TransactionStatus

"SUCCESS"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	SUCCESS
anonymous	PENDING
anonymous	REDIRECT
anonymous	CANCELLED
anonymous	ERROR

TransactionType

"DEBIT"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	DEBIT
anonymous	CAPTURE
anonymous	DEREGISTER
anonymous	PREAUTHORIZE
anonymous	REFUND
anonymous	REGISTER
anonymous	VOID
anonymous	CHARGEBACK
anonymous	CHARGEBACK-REVERSAL
anonymous	PAYOUT
anonymous	INCREMENTAL-AUTHORIZATION
anonymous	DISPUTE
anonymous	DISPUTE-REVERSAL

TransactionSubType

"cb-resolved"

Only present if transaction has a subType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Only present if transaction has a subType

Enumerated Values

Property	Value
anonymous	cb-resolved
anonymous	cb-reversal-resolved

Callback

{
  "result": "OK",
  "uuid": "string",
  "merchantTransactionId": "string",
  "purchaseId": "string",
  "transactionType": "DEBIT",
  "paymentMethod": "string",
  "amount": "string",
  "currency": "string",
  "surchargeAmount": "string",
  "totalAmount": "string",
  "scheduleData": {
    "scheduleId": "string",
    "scheduleStatus": "ACTIVE",
    "scheduledAt": "string",
    "merchantMetaData": "string"
  },
  "notificationSource": "reconciliation",
  "originalAmount": "string",
  "originalCurrency": "string",
  "customerProfileData": {
    "profileGuid": "string",
    "customerIdentification": "string",
    "paymentToken": "string",
    "markAsPreferred": true
  },
  "errorMessage": "string",
  "errorCode": 0,
  "adapterMessage": "string",
  "adapterCode": "string",
  "chargebackData": {
    "originalUuid": "string",
    "originalMerchantTransactionId": "string",
    "amount": "string",
    "currency": "string",
    "reason": "string",
    "chargebackDateTime": "string",
    "disputeData": {
      "adapterDisputeId": "string",
      "status": "string",
      "reasonText": "string",
      "reasonCode": "string",
      "metaData": "string",
      "createdAt": "string",
      "modifiedAt": "string"
    }
  },
  "chargebackReversalData": {
    "originalUuid": "string",
    "originalMerchantTransactionId": "string",
    "chargebackUuid": "string",
    "amount": "string",
    "currency": "string",
    "reason": "string",
    "reversalDateTime": "string"
  },
  "extraData": {
    "property1": "string",
    "property2": "string"
  },
  "merchantMetaData": "string",
  "returnData": {
    "_TYPE": "cardData",
    "type": "string",
    "firstName": "string",
    "lastName": "string",
    "country": "string",
    "cardHolder": "string",
    "expiryMonth": "string",
    "expiryYear": "string",
    "binDigits": "string",
    "firstSixDigits": "string",
    "lastFourDigits": "string",
    "fingerprint": "string",
    "binBrand": "string",
    "binBank": "string",
    "binType": "string",
    "binLevel": "string",
    "binCountry": "string",
    "binSegment": "Consumer",
    "binRawData": {
      "type": "string",
      "data": {}
    },
    "threeDSecure": "string",
    "eci": "string",
    "merchantAdviceCode": "string",
    "parsedMerchantAdviceCode": "string",
    "schemeTransactionIdentifier": "string",
    "schemeLifecycleIdentifier": "string",
    "referenceSchemeLifecycleIdentifier": "string",
    "cardUpdateStatus": "updated",
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  },
  "customer": {
    "identification": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "M",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingPostcode": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPhone": "string",
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingCompany": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingCity": "string",
    "shippingPostcode": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPhone": "string",
    "company": "string",
    "email": "string",
    "emailVerified": true,
    "ipAddress": "string",
    "nationalId": "string",
    "extraData": {
      "property1": "string",
      "property2": "string"
    },
    "paymentData": {
      "ibanData": {
        "iban": "string",
        "bic": "string",
        "mandateId": "string",
        "mandateDate": "string"
      }
    }
  },
  "tracingData": {
    "transactions": [
      {
        "uuid": "string",
        "sequence_number": "string",
        "status": "string",
        "connector": {
          "guid": "string",
          "adapter_name": "string",
          "brand": "string"
        }
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
result	string	false	none	none
uuid	string	false	none	none
merchantTransactionId	string	false	none	none
purchaseId	string	false	none	none
transactionType	TransactionType	false	none	none
paymentMethod	string	false	none	none
amount	Amount	false	none	none
currency	Currency	false	none	none
surchargeAmount	Amount	false	none	Only present if surcharge was applied
totalAmount	Amount	false	none	Only present if surcharge was applied
scheduleData	ScheduleData	false	none	none
notificationSource	string	false	none	none
originalAmount	Amount	false	none	none
originalCurrency	Currency	false	none	none
customerProfileData	CustomerProfileData	false	none	none
errorMessage	string	false	none	none
errorCode	integer(int32)	false	none	none
adapterMessage	string	false	none	none
adapterCode	string	false	none	none
chargebackData	ChargebackData	false	none	none
chargebackReversalData	ChargebackReversalData	false	none	none
extraData	ExtraData	false	none	none
merchantMetaData	string	false	none	none
returnData	ReturnData	false	none	none
customer	Customer	false	none	none
tracingData	TracingData	false	none	Present only if tracing was enabled in payment request

Enumerated Values

Property	Value
result	OK
result	PENDING
result	ERROR
notificationSource	reconciliation
notificationSource	settlement

PayByLink

{
  "sendByEmail": true,
  "expirationInMinute": 1
}

Properties

Name	Type	Required	Restrictions	Description
sendByEmail	boolean	false	none	none
expirationInMinute	integer(int32)	false	none	none