Pay
This action is the default action for Request To Pay. This action is used to initiate the payment
Request
JSON gateway request
|
DebtorName
string
|
The name of the consumer. |
JSON
copy
{
"Currency": "EUR",
"AmountDebit": 0.01,
"Invoice": "testinvoice 123",
"Services": {
"ServiceList": [
{
"Name": "RequestToPay",
"Action": "Pay",
"Parameters": [
{
"Name": "DebtorName",
"GroupType": "",
"GroupID": "",
"Value": "J. De Tester"
} ]
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
If the request has a valid structure and a valid signature, a transaction is created in the Payment Engine and a response will be returned. In this case, an additional action is required before the transaction can be completed. The customer needs to be redirected to the payment environment through the returned redirectURL
JSON
copy
{
"Key": "4E29CC4515FF48E39D4E4FXXXXXXXXXX",
"Status": {
"Code": {
"Code": 791,
"Description": "Pending processing"
},
"SubCode": {
"Code": "S002",
"Description": "An additional action is required: Redirect to RequestToPay."
},
"DateTime": "2020-05-13T10:39:05"
},
"RequiredAction": {
"RedirectURL": "https://checkout.buckaroo.nl/html/redirect.ashx?r=45F384AE35334042B12F23XXXXXXXXXX",
"RequestedInformation": null,
"PayRemainderDetails": null,
"Name": "Redirect",
"TypeDeprecated": 0
},
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "RequestToPay",
"IsTest": false,
"Currency": "EUR",
"AmountDebit": 0.01,
"TransactionType": "C019",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "593F0B1C4AD349FF9D726BXXXXXXXXXX"
}Push
JSON Push Response
|
CustomerIban
string
|
The IBAN number that is used to complete the transaction |
|
CustomerBic
string
|
The BIC number that is used to complete the transaction. This is not always available |
|
CustomerAccountName
string
|
The customer account name. This is the same as what is used when creating the request |
JSON
copy
{
"Transaction":{
"Key":"4E29CC4515FF48E39D4E4FXXXXXXXXXX",
"Invoice":"testinvoice 123",
"ServiceCode":"RequestToPay",
"Status":{
"Code":{
"Code":190,
"Description":"Success"
},
"SubCode":{
"Code":"S990",
"Description":"The request was successful."
},
"DateTime":"2020-05-13T10:44:08"},
"IsTest":false,
"Order":null,
"Currency":"EUR",
"AmountDebit":0.01,
"TransactionType":"C019",
"Services":[
{
"Name":"RequestToPay",
"Action":null,
"Parameters":[
{
"Name":"customeriban",
"Value":"NL26ABNA0123456789"
},
{
"Name":"customerbic",
"Value":""
},
{
"Name":"customeraccountname",
"Value":"J. De Tester"
}
],
"VersionAsProperty":1
}
],
"CustomParameters":null,
"AdditionalParameters":null,
"MutationType":1,
"RelatedTransactions":null,
"IsCancelable":false,
"IssuingCountry":null,
"StartRecurrent":false,
"Recurring":false,
"CustomerName":"Joeri",
"PayerHash":null,
"PaymentKey":"593F0B1C4AD349FF9D726BXXXXXXXXXX"
}
}Refund
To refund a successfully performed Request To Pay transaction, use the action Refund. This this initiate a SEPA Credit Transfer
Request
JSON gateway request
|
OriginalTransactionKey
string
|
Required
Transaction key of the original transaction that needs to be refunded. Please note: This is a basic parameter, not a service specific parameter. This value is a 32-character hex string. |
JSON
copy
{
"Currency": "EUR",
"AmountCredit": 0.01,
"Invoice": "testinvoice 123",
"OriginalTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX",
"Services": {
"ServiceList": [
{
"Name": "requesttopay",
"Action": "Refund"
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
JSON
copy
{
"Key": "F996EE747ECD43CDA8851C5F83XXXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2020-04-15T09:03:45"
},
"RequiredAction": null,
"Services": [
{
"Name": "requesttopay",
"Action": null,
"Parameters": [
{
"Name": "customeraccountname",
"Value": "J. de Tèster"
},
{
"Name": "CustomerIBAN",
"Value": "NL44RABO0123456789"
},
{
"Name": "CustomerBIC",
"Value": "RABONL2U"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "requesttopay",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 0.01,
"TransactionType": "C020",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "J. de Tèster",
"PayerHash": null,
"PaymentKey": "AE8B6E18A2684846AAAF06A63FXXXXXX"
}Push
JSON push response
JSON
copy
{
"Transaction": {
"Key": "F996EE747ECD43CDA8851C5F83XXXXXX",
"Invoice": "testinvoice 123",
"ServiceCode": "requesttopay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2020-04-15T09:03:45"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 0.01,
"TransactionType": "C020",
"Services": [
{
"Name": "requesttopay",
"Action": null,
"Parameters": [
{
"Name": "customeraccountname",
"Value": "J. de Tèster"
},
{
"Name": "CustomerIBAN",
"Value": "NL44RABO0123456789"
},
{
"Name": "CustomerBIC",
"Value": "RABONL2U"
}
],
"VersionAsProperty": 2
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "4E8BD922192746C3918BF4077CXXXXXX"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "J. de Tèster",
"PayerHash": null,
"PaymentKey": "AE8B6E18A2684846AAAF06A63FXXXXXX"
}
}