Pay

The pay action is the default action for the Transfer service. The action is used to register a payment and it will result in a pending transaction and bank transfer details that are either shown to the customer or returned to the merchant, so that the merchant can show them. Optionally, an email is sent to the customer with the same bank details. After the money arrives on the Buckaroo bank account, the transaction status is updated to success.

Please note – very important:

If the actually transferred amount does not match the original transaction, a new transfer transaction is created, which is a copy of the original, with only a different amount, and that one is set to success. This new transaction will send a push message (see the Gateway manual for information about push messages) with the same invoice number and a success status, with one of the parameters being the amount of this transaction. It is therefore very important you check the amount of the push message, so your system knows what amount has been paid and you do not automatically set an order to status “paid” in your system when the incorrect amount has been transferred by the customer.

Base JSON Request

Use the base request as instructed on this page

Pay Request Parameters

Service Specific Parameters

Parameter	Type	Required	Recommended	Description
CustomerGender				Gender of the customer, possible values: 1: Male, 2: Female, 0: Unknown, 9: Not applicable.
CustomerEmail	string	Required		The e-mail address of the customer.
CustomerFirstName	string	Required		The first name of the customer.
CustomerLastName	string	Required		The surname of the customer.
SendMail	boolean		true	If true (default), the BPE will send an email with the payment details to the customer.
DateDue	datetime			The date by which the customer should pay. This is only for display purposes, for email templates.
CustomerCountry	string			The 2-letter iso-code specifying the country for which the bank details should be used.

Example Request

{
   "Currency": "EUR",
   "AmountDebit": 10,
   "Invoice": "testinvoice 123",
   "Services": {
      "ServiceList": [
         {
            "Name": "transfer",
            "Action": "Pay",
            "Parameters": [
               {
                  "Name": "CustomerFirstName",
                  "Value": "John"
               },
               {
                  "Name": "CustomerLastName",
                  "Value": "Smith"
               },
               {
                  "Name": "CustomerGender",
                  "Value": "0"
               },
               {
                  "Name": "CustomerCountry",
                  "Value": "NL"
               },
               {
                  "Name": "SendMail",
                  "Value": "true"
               },
               {
                  "Name": "CustomerEmail",
                  "Value": "[email protected]"
               },
               {
                  "Name": "DateDue",
                  "Value": "2019-01-01"
               }
            ]
         }
      ]
   }
}

Pay Response Parameters

Service Specific Parameters

Parameter	Type	Description
PaymentReference	string	This is the payment reference (or description), which the customer needs to provide.
BankAccount	string	The localized bank account number.
BIC	string	The BIC code identifying the bank to which the payment must be made.
IBAN	string	The IBAN code identifying the bank account to which the payment must be made.
AccountHolderName	string	The name of the account holder of the account to which the payment must be made.
AccountHolderCity	string	The city of the account holder.
AccountHolderCountry	string	The country of the account holder.

Example Response

{
   "Key": "DFA1E22BC3FD4E3CBA0D0D60E0BDXXXX",
   "Status": {
      "Code": {
         "Code": 792,
         "Description": "Waiting for consumer"
      },
      "SubCode": {
         "Code": "C300",
         "Description": "The payment for this transfer is still being expected."
      },
      "DateTime": "2018-01-08T10:29:21"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "transfer",
         "Action": null,
         "Parameters": [
            {
               "Name": "BIC",
               "Value": "RABONL2U"
            },
            {
               "Name": "IBAN",
               "Value": "NL05RABO0121503038"
            },
            {
               "Name": "AccountHolderName",
               "Value": "Buckaroo Stichting Derdengelden"
            },
            {
               "Name": "BankAccount",
               "Value": "1215.03.038"
            },
            {
               "Name": "AccountHolderCity",
               "Value": "Utrecht"
            },
            {
               "Name": "AccountHolderCountry",
               "Value": "The Netherlands"
            },
            {
               "Name": "PaymentReference",
               "Value": "5112XXXX"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "Invoice": "testinvoice 123",
   "ServiceCode": "transfer",
   "IsTest": false,
   "Currency": "EUR",
   "AmountDebit": 10,
   "TransactionType": "C001",
   "MutationType": 1,
   "RelatedTransactions": null,
   "ConsumerMessage": {
      "MustRead": true,
      "CultureName": "en-US",
      "Title": "Transfer to bank account",
      "PlainText": "Please transfer the specified amount (10.00 EUR) stating the payment reference 5112XXXX, using the bank details below:\r\n\r\nPayment reference: 5112XXXX\r\nAccountholder: Buckaroo Stichting Derdengelden\r\nIBAN: NL05RABO0121503038\r\nBIC: RABONL2U",
      "HtmlText": "Please transfer the specified amount (EUR 10.00) stating the payment reference 51122469, using the bank details below:\r\n<br/>\r\n<table class=\"bankdetails\">\r\n\t<tr>\r\n\t\t<td class=\"label\" id=\"amountlabel\">Amount:<\/td>\r\n\t\t<td class=\"labelvalue\" id=\"amount\">EUR 10.00<\/td>\r\n\t<\/tr>\r\n\t<tr>\r\n\t\t<td class=\"label\" id=\"referencelabel\">Payment reference:<\/td>\r\n\t\t<td class=\"labelvalue\" id=\"reference\">5112XXXX<\/td>\r\n\t<\/tr>\r\n  <tr>\r\n\t\t<td class=\"label\" id=\"accountholdernamelabel\">Accountholder:<\/td>\r\n\t\t<td class=\"labelvalue\" id=\"accountholdername\">Buckaroo Stichting Derdengelden<\/td>\r\n\t<\/tr>\r\n\t<tr>\r\n\t\t<td class=\"label\" id=\"ibanlabel\">IBAN-code:<\/td>\r\n\t\t<td class=\"labelvalue\" id=\"ibancode\">NL05RABO0121503038<\/td>\r\n\t<\/tr>\r\n\t<tr>\r\n\t\t<td class=\"label\" id=\"biclabel\">BIC-code:<\/td>\r\n\t\t<td class=\"labelvalue\" id=\"biccode\">RABONL2U<\/td>\r\n<\/table>"
   },
   "Order": null,
   "IssuingCountry": null,
   "StartRecurrent": false,
   "Recurring": false,
   "CustomerName": "John Smith",
   "PayerHash": null,
   "PaymentKey": "45ED99DBDAB34FBD98A16B8D0430XXXX"
}

Pay Push Parameters

Example Push

{
   "Transaction": {
      "Key": "DFA1E22BC3FD4E3CBA0D0D60E0BXXXXX",
      "Invoice": "testinvoice 123",
      "ServiceCode": "transfer",
      "Status": {
         "Code": {
            "Code": 792,
            "Description": "Wacht op consument"
         },
         "SubCode": {
            "Code": "C300",
            "Description": "Betaling voor deze overschrijving wordt nog verwacht."
         },
         "DateTime": "2018-01-08T10:29:21"
      },
      "IsTest": false,
      "Order": null,
      "Currency": "EUR",
      "AmountDebit": 10,
      "TransactionType": "C001",
      "Services": [
         {
            "Name

": "transfer",
            "Action": null,
            "Parameters": [
               {
                  "Name": "CustomerIban",
                  "Value": "NL06ABNAXXXXXXXXXX"
               },
               {
                  "Name": "CustomerBic",
                  "Value": "ABNANL2A"
               },
               {
                  "Name": "CustomerAccountName",
                  "Value": "John Smith"
               },
               {
                  "Name": "BIC",
                  "Value": "RABONL2U"
               },
               {
                  "Name": "IBAN",
                  "Value": "NL05RABO0121503038"
               },
               {
                  "Name": "AccountHolderName",
                  "Value": "Buckaroo Stichting Derdengelden"
               },
               {
                  "Name": "BankAccount",
                  "Value": "1215.03.038"
               },
               {
                  "Name": "AccountHolderCity",
                  "Value": "Utrecht"
               },
               {
                  "Name": "AccountHolderCountry",
                  "Value": "The Netherlands"
               },
               {
                  "Name": "PaymentReference",
                  "Value": "5112XXXX"
               }
            ],
            "VersionAsProperty": 1
         }
      ],
      "CustomParameters": null,
      "AdditionalParameters": null,
      "MutationType": 1,
      "RelatedTransactions": null,
      "IsCancelable": false,
      "IssuingCountry": null,
      "StartRecurrent": false,
      "Recurring": false,
      "CustomerName": "John Smith",
      "PayerHash": null,
      "PaymentKey": "45ED99DBDAB34FBD98A16B8D0430XXXX"
   }
}

Refund

To refund a successfully performed Transfer transaction, use the action Refund. A bank transfer is then initiated.

Refund Request

{
  "Currency": "EUR",
  "AmountCredit": 0.01,
  "Invoice": "Testinvoice 123",
  "OriginalTransactionKey": "8C04E70CXXXXXXXXXXXXXXXX2C7A6606",
  "Services": {
    "ServiceList": [
      {
        "Name": "Transfer",
        "Action": "Refund"
      }
    ]
  }
}

Refund Response Parameters

Parameter	Type	Required	Description
CustomerAccountName	string	N/A	The beneficiary of the bank account from which the payment was made.
ConsumerIBAN	string	N/A	The international bank account number (IBAN code) of the bank of the consumer. Note: This field is optional. In some countries, banks cannot provide this information.
ConsumerBIC	string	N/A	The bank identifier (BIC code) of the bank of the consumer. Note: This field is optional. In some countries, banks cannot provide this information.

Example Response

{
    "Key": "173B79B45XXXXXXXXXXXXXXXX4D01898",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
        },
        "DateTime": "2023-11-09T09:13:58"
    },
    "RequiredAction": null,
    "Services": [
        {
            "Name": "transfer",
            "Action": null,
            "Parameters": [
                {
                    "Name": "CustomerAccountName",
                    "Value": "XXXXX"
                },
                {
                    "Name": "CustomerIBAN",
                    "Value": "NLXXABNAXXXXXXXXXX"
                },
                {
                    "Name": "CustomerBIC",
                    "Value": "ABNANL2A"
                },
                {
                    "Name": "Processed",
                    "Value": "Classic"
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "Testinvoice 123",
    "ServiceCode": "transfer",
    "IsTest": false,
    "Currency": "EUR",
    "AmountCredit": 0.01,
    "TransactionType": "C101",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "8C04E70CXXXXXXXXXXXXXXXX2C7A6606"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "XXX",
    "PayerHash": null,
    "PaymentKey": "77C1FF9XXXXXXXXXXXXXXXXE3DBBAA47"
}