Requests

Pay

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

📘
Note
Use the base request as instructed on this page.

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:

Find basic parameters here.

Example request 1 (requires domain association file)

{
   "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	Description
CardNumberEnding	String	Last 4 digits of the credit card number.
CardExpirationDate	String	Credit card expiration date.
MaskedCreditcardNumber	String	Masked card number.

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

Example request 2 (does not require a domain association file)

{
 "Currency": "EUR",
 "AmountDebit": 10.00,
 "Description": "Apple Pay without domain assocation file",
 "Invoice": "12345678",
 "ReturnURL": "https://www.buckaroo.nl",
 "ReturnURLCancel": "https://www.buckaroo.nl/annuleren",
 "ReturnURLError": "https://www.buckaroo.nl/mislukt",
 "ServicesSelectableByClient": "applepay",
 "ReturnURLReject": "https://www.buckaroo.nl/geweigerd",
 "ContinueOnIncomplete": "1"
}

Pay Push

Parameters

Service-specific parameters

Parameter	Type	Description
CardNumberEnding	String	Last 4 digits of the credit card number.
CardExpirationDate	String	Credit card expiration date.
MaskedCreditcardNumber	String	Masked card number.

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.

Example request

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

Refund Response

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

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

StartRecurrent & PayRecurrent

StartRecurrent

This request initializes a recurring payment setup for Apple Pay. It creates the initial transaction that can be referenced by future PayRecurrent calls.

Note: The parameter StartRecurrent is required to mark the transaction as the starting point of a recurring payment series.

Example request

{
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "Description": "ApplePay StartRecurrent",
    "Invoice": "ApplePay Invoice test123",
    "StartRecurrent": "true",
    "ContinueOnIncomplete": true,
    "Services": {
        "ServiceList": [
            {
                "Name": "ApplePay",
                "Action": "Pay",
                "Parameters": null
            }
        ]
    }
}

Example response

{
    "Key": "C6DE4463704C4743B421CED62B98905A",
    "Status": {
        "Code": {
            "Code": 790,
            "Description": "Pending input"
        },
        "SubCode": null,
        "DateTime": "2025-10-28T15:36:14"
    },
    "RequiredAction": {
        "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=18C196B8A9CB482CB5AAB16A6628D758",
        "RequestedInformation": null,
        "PayRemainderDetails": null,
        "Name": "Redirect",
        "TypeDeprecated": 0
    },
    "Invoice": "ApplePay Invoice test123",
    "ServiceCode": "applepay",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "StartRecurrent": true,
    "Recurring": false
}

PayRecurrent

Payment method: Apple Pay Action: PayRecurrent Service: applepay

This request is used to perform a recurrent Apple Pay payment using a previously authorized transaction reference.

Example request

{
    "Invoice": "ApplePay test invoice 123",
    "Description": "ApplePay description",
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "ContinueOnIncomplete": true,
    "OriginalTransactionKey": "C6DE4463704C4743B421CED62B98905A",
    "Services": {
        "ServiceList": [
            {
                "Name": "ApplePay",
                "Action": "PayRecurrent"
            }
        ]
    }
}

Note: Parameter OriginalTransactionType is required.

Example response

{
    "Key": "17945D98A38F49879CCDB6D7E9983B76",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2025-10-28T15:42:42"
    },
    "Services": [
        {
            "Name": "applepay",
            "Action": null,
            "Parameters": [
                {"Name": "CardNumberEnding","Value": "6906"},
                {"Name": "CardExpirationDate","Value": "2031-12"},
                {"Name": "MaskedCreditcardNumber","Value": "427106******6906"}
            ]
        }
    ],
    "Invoice": "ApplePay test invoice 123",
    "ServiceCode": "applepay",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "TransactionType": "C042",
    "IssuingCountry": "DE",
    "StartRecurrent": false,
    "Recurring": true,
    "CustomerName": "Zejnel Morina",
    "PaymentKey": "975B56C52C1943198C0F5D89AF793894"
}

Push

Example push

{
  "Transaction": {
    "Key": "A97AAC2701044D1998AD140B5BE5F600",
    "Invoice": "ApplePay test invoice 123",
    "ServiceCode": "applepay",
    "Status": {
      "Code": {"Code": 190,"Description": "Success"},
      "SubCode": {"Code": "S990","Description": "The request was successful."},
      "DateTime": "2025-10-28T15:48:05"
    },
    "IsTest": false,
    "Currency": "EUR",
    "AmountDebit": 0.01,
    "TransactionType": "C042",
    "Services": [
      {"Name": "applepay","Parameters": [
          {"Name": "CardNumberEnding","Value": "6906"},
          {"Name": "CardExpirationDate","Value": "2031-12"},
          {"Name": "MaskedCreditcardNumber","Value": "427106******6906"}
      ],"VersionAsProperty": 1}
    ],
    "IssuingCountry": "DE",
    "StartRecurrent": false,
    "Recurring": true,
    "CustomerName": "Zejnel Morina",
    "PaymentKey": "DD74909221654373821267699E9B3830",
    "Description": "ApplePay description"
  }
}