Requests

Requests


Pay

The Pay action is the default action. The action is used to perform a single payment with Apple Pay.

Base JSON request

Use the base request as instructed on this page

Pay request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
PaymentData String Yes N/A This can be retrieved from the "captureInfo"-variables of our Client Side Encryption SDK.
CustomerCardName String No N/A This can be retrieved from the "captureInfo"-variables of our Client Side Encryption SDK.
Basic parameters

Example request

{
   "Currency": "EUR",
   "AmountDebit": 1.00,
   "Invoice": "10000480",
   "Services": {
      "ServiceList": [
         {
            "Name": "applepay",
            "Action": "Pay",
            "Parameters": [
               {
                  "Name": "PaymentData",
                  "Value": "XXXXXXXXXXXXX"
               },
               {
                  "Name": "CustomerCardName",
                  "Value": "XXXXXXXXXXXXX"
               }
            ]
         }
      ]
   }
}

Pay response

Parameters

Service specific parameters

Parameter Type Required Recommended Description
CardNumberEnding String Last 4 digits of the creditcard number.
CardExpirationDate String Credit card expiration date.
MaskedCreditcardNumber String Masked card number.
Basic parameters

Example response

{
   "Key": "9AA4C81A08A84FA7B68E6A6A6291XXXX",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2019-06-13T09:19:52"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "applepay",
         "Action": null,
         "Parameters": [
            {
               "Name": "CardNumberEnding",
               "Value": "00XX"
            },
            {
               "Name": "CardExpirationDate",
               "Value": "0019-07"
            },
            {
               "Name": "MaskedCreditcardNumber",
               "Value": "XXXXXX******XXXX"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "RequestErrors": null,
   "Invoice": "10000480",
   "ServiceCode": "applepay",
   "IsTest": true,
   "Currency": "EUR",
   "AmountDebit": 1.00,
   "TransactionType": "V187",
   "MutationType": 2,
   "RelatedTransactions": null,
   "ConsumerMessage": null,
   "Order": "10000480",
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": "XXXXXXXXXXXX",
   "PayerHash": "XXXXXXXXXXXXXXXXXXX",
   "PaymentKey": "XXXXXXXXXXXXXXXXXXXXXX"
}

Pay push

Parameters

Service specific parameters

Parameter Type Required Recommended Description
CardNumberEnding String Last 4 digits of the creditcard number.
CardExpirationDate String Credit card expiration date.
MaskedCreditcardNumber String Masked card number.
Basic parameters

Example Push

{
   "Transaction": {
      "Key": "9AA4C81A08A84FA7B68E6A6A6291XXXX",
      "Invoice": "10000480",
      "ServiceCode": "applepay",
      "Status": {
         "Code": {
            "Code": 190,
            "Description": "Success"
         },
         "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
         },
         "DateTime": "2019-06-13T09:19:52"
      },
      "IsTest": true,
      "Order": "10000480",
      "Currency": "EUR",
      "AmountDebit": 1,
      "TransactionType": "V187",
      "Services": [
         {
            "Name": "applepay",
            "Action": null,
            "Parameters": [
               {
                  "Name": "CardNumberEnding",
                  "Value": "00XX"
               },
               {
                  "Name": "CardExpirationDate",
                  "Value": "0019-07"
               },
               {
                  "Name": "MaskedCreditcardNumber",
                  "Value": "XXXXXX******XXXX"
               }
            ],
            "VersionAsProperty": 1
         }
      ],
      "CustomParameters": null,
      "MutationType": 2,
      "RelatedTransactions": null,
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": "XXXXXXXXXXXX",
      "PayerHash": "XXXXXXXXXXXXXXXXXXX",
      "PaymentKey": "XXXXXXXXXXXXXXXXXXXXXX"
   }
}

Refund

Refund request

Parameters

Service specific parameters

Parameter Type Required Recommended Description
OriginalTransactionKey String Yes N/A Transaction key of the payment that needs to be refunded. Please note: This is a basic parameter, not a service specific parameter.
Basic parameters

Example request

{
   "Currency": "EUR",
   "AmountCredit": 1.00,
   "Invoice": "10000480",
   "OriginalTransactionKey": "XXXXXXXXXXXXXXX",
   "Services": {
      "ServiceList": [
         {
            "Name": "applepay",
            "Action": "refund"
         }
      ]
   }
}

Refund response

Parameters

Basic parameters

Example response

{
   "Key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2019-06-13T09:20:24"
   },
   "RequiredAction": null,
   "Services": null,
   "CustomParameters": null,
   "RequestErrors": null,
   "Invoice": "10000480",
   "ServiceCode": "applepay",
   "IsTest": true,
   "Currency": "EUR",
   "AmountCredit": 1.00,
   "TransactionType": "V188",
   "MutationType": 2,
   "RelatedTransactions": [
      {
         "RelationType": "refund",
         "RelatedTransactionKey": "XXXXXXXXXXXXXXXXXXXXX"
      }
   ],
   "ConsumerMessage": null,
   "Order": null,
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": "XXXXXXXXXXXX",
   "PayerHash": null,
   "PaymentKey": "XXXXXXXXXXXXXXXX"
}

Refund push

Parameters

Basic parameters

Example push

{
   "Key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2019-06-13T09:20:24"
   },
   "RequiredAction": null,
   "Services": null,
   "CustomParameters": null,
   "RequestErrors": null,
   "Invoice": "10000480",
   "ServiceCode": "applepay",
   "IsTest": true,
   "Currency": "EUR",
   "AmountCredit": 1.00,
   "TransactionType": "V188",
   "MutationType": 2,
   "RelatedTransactions": [
      {
         "RelationType": "refund",
         "RelatedTransactionKey": "XXXXXXXXXXXXXXXXXXXXX"
      }
   ],
   "ConsumerMessage": null,
   "Order": null,
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": "XXXXXXXXXXXX",
   "PayerHash": null,
   "PaymentKey": "XXXXXXXXXXXXXXXX"
}

Was dit artikel nuttig?

What's Next