Requests
Requests
Article summary
Did you find this summary helpful?
Thank you for your feedback
Pay
The Pay action can be used to perform a payment.
Base JSON request
Use the base request as instructed on this page
Pay request
Parameters
Service specific parameters
None
Basic parameters
Example request
{
"Currency": "EUR",
"AmountDebit": 0.01,
"AmountCredit": null,
"Invoice": "T2TBUHM90RTYGYFAIOC",
"Order": null,
"Description": "Pay for invoice: T2TBUHM90RTYGYFAIOC",
"ClientIP": null,
"ReturnURL": "https://www.buckaroo.nl",
"ReturnURLCancel": "https://www.buckaroo.nl/annuleren",
"ReturnURLError": "https://www.buckaroo.nl/mislukt",
"ReturnURLReject": "https://www.buckaroo.nl/geweigerd",
"OriginalTransactionKey": null,
"ServicesSelectableByClient": null,
"ServicesExcludedForClient": null,
"PushURL": null,
"PushURLFailure": null,
"ClientUserAgent": null,
"OriginalTransactionReference": null,
"Services": {
"ServiceList": [
{
"Name": "Multibanco",
"Action": "Pay",
"Version": 0,
"Parameters": []
}
]
},
"CustomParameters": null,
"AdditionalParameters": null
}
Pay response
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|
Basic parameters
Example response
{
"Key": "75B215A6FD844380BC98************",
"Status": {
"Code": {
"Code": 791,
"Description": "Pending processing"
},
"SubCode": {
"Code": "S002",
"Description": "An additional action is required: Redirect to Multibanco."
},
"DateTime": "2023-11-16T15:47:17"
},
"RequiredAction": {
"RedirectURL": "https://checkout.buckaroo.nl/html/redirect.ashx?r=C110BDAD720843A182E704C03B8EB623",
"RequestedInformation": null,
"PayRemainderDetails": null,
"Name": "Redirect",
"TypeDeprecated": 0
},
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "T2TBUHM90RTYGYFAIOC",
"ServiceCode": "Multibanco",
"IsTest": false,
"Currency": "EUR",
"AmountDebit": 0.01,
"TransactionType": "C129",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "C3A5706A668B44418A**************"
}
Pay push
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|
Basic parameters
Example push
{
"Transaction": {
"Key": "75B215A6FD844380BC989************",
"Invoice": "T2TBUHM90RTYGYFAIOC",
"ServiceCode": "Multibanco",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-11-16T15:47:20"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0.01,
"TransactionType": "C129",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "J. de Tèster",
"PayerHash": null,
"PaymentKey": "C3A5706A668B44418A3C************",
"Description": "Pay for invoice: T2TBUHM90RTYGYFAIOC"
}
}
Refund
The Refund action can be used to perform a refund.
Base JSON request
Use the base request as instructed on this page
Refund request
Parameters
Service specific parameters
None
Basic parameters
Example request
{
"Currency": "EUR",
"AmountDebit": null,
"AmountCredit": 0.01,
"Invoice": "1TTXP19PNH5ZQE5X1JI",
"Order": null,
"Description": "Refund for Invoice: T2TBUHM90RTYGYFAIOC",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"ReturnURL": null,
"ReturnURLCancel": null,
"ReturnURLError": null,
"ReturnURLReject": null,
"OriginalTransactionKey": "75B215A6FD844380BC9*************",
"ServicesSelectableByClient": null,
"ServicesExcludedForClient": null,
"PushURL": null,
"PushURLFailure": null,
"ClientUserAgent": null,
"OriginalTransactionReference": null,
"Services": {
"ServiceList": [
{
"Name": "Multibanco",
"Action": "Refund",
"Version": 0,
"Parameters": []
}
]
},
"CustomParameters": null,
"AdditionalParameters": null
}
Refund response
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|
Basic parameters
Example response
{
"Key": "9D5D535E50134B499BFC************",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-11-16T15:47:24"
},
"RequiredAction": null,
"Services": [
{
"Name": "Multibanco",
"Action": null,
"Parameters": [
{
"Name": "CustomerIBAN",
"Value": "NL44RABO0123456789"
},
{
"Name": "CustomerBIC",
"Value": "RABONL2U"
},
{
"Name": "Processed",
"Value": "Classic"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "1TTXP19PNH5ZQE5X1JI",
"ServiceCode": "Multibanco",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 0.01,
"TransactionType": "C130",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "75B215A6FD844380BC9************"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "9BA1B82DF8474668B9************"
}
Refund push
Parameters
Service specific parameters
| Parameter | Type | Required | Recommended | Description |
|---|
Basic parameters
Example push
{
"Transaction": {
"Key": "9D5D535E50134B499BFC**********",
"Invoice": "1TTXP19PNH5ZQE5X1JI",
"ServiceCode": "Multibanco",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2023-11-16T15:47:24"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 0.01,
"TransactionType": "C130",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "75B215A6FD844380BC9**********"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "9BA1B82DF8474668B9***********",
"Description": "Refund for Invoice: T2TBUHM90RTYGYFAIOC"
}
}
Was this article helpful?