Requests

      Requests


        Article Summary

        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

        ParameterTypeRequiredRecommendedDescription
        PhonenumberstringOptionalInput
        PaymentPurposestringOptioonalOutput
        Basic parameters

        Example request

        {
          "Currency": "EUR",
          "AmountDebit": 0.01,
          "AmountCredit": null,
          "Invoice": "736NB994T20IDH7DLV4",
          "Order": null,
          "Description": "Pay for invoice: 736NB994T20IDH7DLV4",
          "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": "MBWay",
                "Action": "Pay",
                "Version": 0,
                "Parameters": []
              }
            ]
          },
          "CustomParameters": null,
          "AdditionalParameters": null
        }
        

        Pay response

        Parameters

        Service specific parameters

        ParameterTypeRequiredRecommendedDescription
        Basic parameters

        Example response

        {
          "Key": "AA4AF82E7BDA4C1BB4A4D***********,
          "Status": {
            "Code": {
              "Code": 791,
              "Description": "Pending processing"
            },
            "SubCode": {
              "Code": "S002",
              "Description": "An additional action is required: Redirect to MBWay."
            },
            "DateTime": "2023-11-16T15:47:07"
          },
          "RequiredAction": {
            "RedirectURL": "https://checkout.buckaroo.nl/html/redirect.ashx?r=9CFE61D7B3A242B487F**************",
            "RequestedInformation": null,
            "PayRemainderDetails": null,
            "Name": "Redirect",
            "TypeDeprecated": 0
          },
          "Services": [
            {
              "Name": "MBWay",
              "Action": null,
              "Parameters": [
                {
                  "Name": "BankStatementId",
                  "Value": "Test payment"
                }
              ]
            }
          ],
          "CustomParameters": null,
          "AdditionalParameters": null,
          "RequestErrors": null,
          "Invoice": "736NB994T20IDH7DLV4",
          "ServiceCode": "MBWay",
          "IsTest": false,
          "Currency": "EUR",
          "AmountDebit": 0.01,
          "TransactionType": "C108",
          "MutationType": 1,
          "RelatedTransactions": null,
          "ConsumerMessage": null,
          "Order": null,
          "IssuingCountry": null,
          "StartRecurrent": false,
          "Recurring": false,
          "CustomerName": null,
          "PayerHash": null,
          "PaymentKey": "F1741418637646C89************"
        }
        

        Pay push

        Parameters

        Service specific parameters

        ParameterTypeRequiredRecommendedDescription
        Basic parameters

        Example push

        {
          "Transaction": {
            "Key": "AA4AF82E7BDA4C1BB4A**************",
            "Invoice": "736NB994T20IDH7DLV4",
            "ServiceCode": "MBWay",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "Success"
              },
              "SubCode": {
                "Code": "S990",
                "Description": "The request was successful."
              },
              "DateTime": "2023-11-16T15:47:10"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountDebit": 0.01,
            "TransactionType": "C108",
            "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": "F1741418637646C898*************",
            "Description": "Pay for invoice: 736NB994T20IDH7DLV4"
          }
        }
        

        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

        | Parameter | Type | Required | Description |
        | PhoneNumber | String | Optional | Input |
        | PaymentPurpose | String | Optional |Output |

        Basic parameters

        Example request

        {
          "Currency": "EUR",
          "AmountDebit": null,
          "AmountCredit": 0.01,
          "Invoice": "F25Y4UAELYLC5VXC3CR",
          "Order": null,
          "Description": "Refund for Invoice: 736NB994T20IDH7DLV4",
          "ClientIP": {
            "Type": 0,
            "Address": "0.0.0.0"
          },
          "ReturnURL": null,
          "ReturnURLCancel": null,
          "ReturnURLError": null,
          "ReturnURLReject": null,
          "OriginalTransactionKey": "AA4AF82E7BDA4C1**************",
          "ServicesSelectableByClient": null,
          "ServicesExcludedForClient": null,
          "PushURL": null,
          "PushURLFailure": null,
          "ClientUserAgent": null,
          "OriginalTransactionReference": null,
          "Services": {
            "ServiceList": [
              {
                "Name": "MBWay",
                "Action": "Refund",
                "Version": 0,
                "Parameters": []
              }
            ]
          },
          "CustomParameters": null,
          "AdditionalParameters": null
        }
        

        Refund response

        Parameters

        Service specific parameters

        ParameterTypeRequiredRecommendedDescription
        Basic parameters

        Example response

        {
          "Key": "911DE8283B504020A2************",
          "Status": {
            "Code": {
              "Code": 190,
              "Description": "Success"
            },
            "SubCode": {
              "Code": "S990",
              "Description": "The request was successful."
            },
            "DateTime": "2023-11-16T15:47:15"
          },
          "RequiredAction": null,
          "Services": [
            {
              "Name": "MBWay",
              "Action": null,
              "Parameters": [
                {
                  "Name": "BankStatementId",
                  "Value": "payment"
                },
                {
                  "Name": "CustomerIBAN",
                  "Value": "NL44RABO0123456789"
                },
                {
                  "Name": "CustomerBIC",
                  "Value": "RABONL2U"
                },
                {
                  "Name": "Processed",
                  "Value": "Classic"
                }
              ]
            }
          ],
          "CustomParameters": null,
          "AdditionalParameters": null,
          "RequestErrors": null,
          "Invoice": "F25Y4UAELYLC5VXC3CR",
          "ServiceCode": "MBWay",
          "IsTest": false,
          "Currency": "EUR",
          "AmountCredit": 0.01,
          "TransactionType": "C109",
          "MutationType": 1,
          "RelatedTransactions": [
            {
              "RelationType": "refund",
              "RelatedTransactionKey": "AA4AF82E7BDA4C1BB*************"
            }
          ],
          "ConsumerMessage": null,
          "Order": null,
          "IssuingCountry": null,
          "StartRecurrent": false,
          "Recurring": false,
          "CustomerName": null,
          "PayerHash": null,
          "PaymentKey": "F6A03605120F4466B*************"
        }
        

        Refund push

        Parameters

        Service specific parameters

        ParameterTypeRequiredRecommendedDescription
        Basic parameters

        Example push

        {
          "Transaction": {
            "Key": "911DE8283B504020A*************",
            "Invoice": "F25Y4UAELYLC5VXC3CR",
            "ServiceCode": "MBWay",
            "Status": {
              "Code": {
                "Code": 190,
                "Description": "Success"
              },
              "SubCode": {
                "Code": "S990",
                "Description": "The request was successful."
              },
              "DateTime": "2023-11-16T15:47:15"
            },
            "IsTest": true,
            "Order": null,
            "Currency": "EUR",
            "AmountCredit": 0.01,
            "TransactionType": "C109",
            "Services": null,
            "CustomParameters": null,
            "AdditionalParameters": null,
            "MutationType": 1,
            "RelatedTransactions": [
              {
                "RelationType": "refund",
                "RelatedTransactionKey": "AA4AF82E7BDA4C1BB***********"
              }
            ],
            "IsCancelable": false,
            "IssuingCountry": null,
            "StartRecurrent": false,
            "Recurring": false,
            "CustomerName": null,
            "PayerHash": null,
            "PaymentKey": "F6A03605120F4466BB3************",
            "Description": "Refund for Invoice: 736NB994T20IDH7DLV4"
          }
        }
        

        Was this article helpful?

        What's Next