Requests

Pay

Base JSON request

📘

Note

Use the base request as instructed on this page.

Parameters

Basic Parameters:

  • Find basic parameters here.

Pay Request

🚧

Note

Always make sure the AmountDebit equals the sum of the article amounts.

Parameters

Service-specific parameters

ParameterTypeRequiredDescription
TrackandtracestringNoTrackandtrace number from carrier
VATNumberstringNoVAT number.
QuantitystringYesGroupType: Article. Article quantity
IdentifierstringYesGroupType: Article. Article identifier
DescriptionstringYesGroupType: Article. Article description
VatPercentagedecimalYesGroupType: Article. Article VAT Percentage
GrossUnitPriceIncldecimalNoGroupType: Article. Article price including VAT
GrossUnitPriceExcldecimalNoGroupType: Article. Article price excluding VAT. Optional for B2B
CategorystringNoGroupType: BillingCustomer. Indicator if it is B2B or B2C. Possible values: B2B, B2C. Default value B2B
CareOfstringNoGroupType: BillingCustomer. Mandatory for B2B. Name of intermediary responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority, and organization names as well - e.g., "Sportverein Blau-Weiß e.V.
ChamberOfCommercestringNoGroupType: BillingCustomer. Chamber of Commerce number
FirstNamestringYesGroupType: BillingCustomer. First name of billing customer
InitialsstringYesGroupType: BillingCustomer. Initials of billing customer
LastNamestringYesGroupType: BillingCustomer. Last name of billing customer
SalutationstringYesGroupType: BillingCustomer. Gender of billing customer. Possible values: Male, Female, Unknown
StreetstringYesGroupType: BillingCustomer. Street of billing customer
StreetNumberdecimalYesGroupType: BillingCustomer. House number of billing customer
StreetNumberAdditionalstringNoGroupType: BillingCustomer. House number suffix of billing customer
PostalCodestringYesGroupType: BillingCustomer. Postal code of billing customer
CitystringYesGroupType: BillingCustomer. City of billing customer
CountrystringNoGroupType: BillingCustomer. Country of billing customer. Only required if country is different from NL. Possible values: NL, BE
MobilePhonestringYesGroupType: BillingCustomer. Mobile phone number of billing customer
EmailstringNoGroupType: BillingCustomer. Email of billing customer
BirthDatedatetimeYesGroupType: BillingCustomer. Birthdate of billing customer
FirstNamestringYesGroupType: ShippingCustomer. Firstname of shipping customer
LastNamestringYesGroupType: ShippingCustomer. Lastname of shipping customer
CareOfstringNoGroupType: ShippingCustomer. Name of intermediary responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority, and organization names as well - e.g., "Sportverein Blau-Weiß e.V.
StreetstringYesGroupType: ShippingCustomer. Street of shipping customer
StreetNumberdecimalYesGroupType: ShippingCustomer. House number of shipping customer
StreetNumberAdditionalstringNoGroupType: ShippingCustomer. House number suffix of shipping customer
PostalCodestringYesGroupType: ShippingCustomer. Postal code of shipping customer
CitystringYesGroupType: ShippingCustomer. City of shipping customer

Example request

{
   "Currency":"EUR",
   "AmountDebit":10.0,
   "Invoice":"TestInvoice 123",
   "Order":null,
   "Description":"Test Invoice 123",
   "Services":{
      "ServiceList":[
         {
            "Name":"Billink",
            "Action":"Pay",
            "Parameters":[
               {
                  "Name":"Trackandtrace",
                  "Value":"TR0F123456789"
               },
               {
                  "Name":"VATNumber",
                  "Value":"2"
               },
               {
                  "Name":"Quantity",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"1"
               },
               {
                  "Name":"Identifier",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Articlenumber12345"
               },
               {
                  "Name":"Description",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Blue Toy Car"
               },
               {
                  "Name":"VatPercentage",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"7"
               },
               {
                  "Name":"GrossUnitPriceIncl",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"10"
               },
               {
                  "Name":"GrossUnitPriceExcl",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"5"
               },
               {
                  "Name":"Category",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"B2C"
               },
               {
                  "Name":"CareOf",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"John Smith"
               },
               {
                  "Name":"ChamberOfCommerce",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Kvk123456789"
               },
               {
                  "Name":"FirstName",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Test"
               },
               {
                  "Name":"Initials",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"T"
               },
               {
                  "Name":"LastName",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Acceptatie"
               },
               {
                  "Name":"Salutation",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Male"
               },
               {
                  "Name":"Street",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Hoofdstraat"
               },
               {
                  "Name":"StreetNumber",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":90
               },
               {
                  "Name":"StreetNumberAdditional",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"A"
               },
               {
                  "Name":"PostalCode",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"8441EE"
               },
               {
                  "Name":"City",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Heerenveen"
               },
               {
                  "Name":"Country",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"NL"
               },
               {
                  "Name":"MobilePhone",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"0698765433"
               },
               {
                  "Name":"Email",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"[email protected]"
               },
               {
                  "Name":"BirthDate",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"01-01-1990"
               },
               {
                  "Name":"Street",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Afleverstraat"
               },
               {
                  "Name":"StreetNumber",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":80
               },
               {
                  "Name":"StreetNumberAdditional",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"B"
               },
               {
                  "Name":"PostalCode",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"7881ER"
               },
               {
                  "Name":"City",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Leeuwarden"
               },
               {
                  "Name":"CareOf",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"John Smith"
               },
               {
                  "Name":"FirstName",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value

":"Test"
               },
               {
                  "Name":"LastName",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Aflever"
               },
               {
                  "Name":"Country",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"NL"
               }
            ]
         }
      ]
   },
   "CustomParameters":null,
   "AdditionalParameters":null
}

 

Pay response

An additional action is required before the transaction can be completed. The customer needs to be redirected to the Billink Checkout through the returned redirect URL.

Parameters

Example response

{
    "Key": "71A5D680871C4A9296EB4D1680FC0924",
    "Status": {
        "Code": {
            "Code": 791,
            "Description": "Pending processing"
        },
        "SubCode": {
            "Code": "S002",
            "Description": "An additional action is required: Redirect to Billink."
        },
        "DateTime": "2025-08-26T10:22:25"
    },
    "RequiredAction": {
        "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=513A4327758A4D3FACAA8485823DEB8D",
        "RequestedInformation": null,
        "PayRemainderDetails": null,
        "Name": "Redirect",
        "TypeDeprecated": 0
    },
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "1756196542",
    "ServiceCode": "Billink",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 10,
    "TransactionType": "C068",
    "MutationType": 1,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "FirstName-Test LastName-Test",
    "PayerHash": null,
    "PaymentKey": "BD74F64B9D644C88A9CDE5CBA528CDDE"
}

Pay Push

Parameters

Example push

{
   "Transaction":{
      "Key":"11A576387EA0483398F87393XXXXXXXX",
      "Invoice":"TestInvoice 123",
      "ServiceCode":"Billink",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"Success"
         },
         "SubCode":{
            "Code":"S990",
            "Description":"The request was successful."
         },
         "DateTime":"2020-11-17T13:56:12"
      },
      "IsTest":true,
      "Order":null,
      "Currency":"EUR",
      "AmountDebit":10.0,
      "TransactionType":"C068",
      "Services":null,
      "CustomParameters":null,
      "AdditionalParameters":null,
      "MutationType":1,
      "RelatedTransactions":null,
      "IsCancelable":false,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":"D9C2713E532B49D99DC27D76XXXXXXXX"
   }
}

Authorize

Performing this action will create an order at Billink. Billink will perform a credit check, and immediately confirm if the transaction is accepted or not.

Authorize Request

Parameters

Example request

{
   "Currency":"EUR",
   "AmountDebit":10.0,
   "Invoice":"TestInvoice 123",
   "Order":null,
   "Description":"Test Invoice 123",
   "Services":{
      "ServiceList":[
         {
            "Name":"Billink",
            "Action":"Authorize",
            "Parameters":[
               {
                  "Name":"Trackandtrace",
                  "Value":"TR0F123456789"
               },
               {
                  "Name":"VATNumber",
                  "Value":"2"
               },
               {
                  "Name":"Quantity",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"1"
               },
               {
                  "Name":"Identifier",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Articlenumber12345"
               },
               {
                  "Name":"Description",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Blue Toy Car"
               },
               {
                  "Name":"VatPercentage",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"7"
               },
               {
                  "Name":"GrossUnitPriceIncl",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"10"
               },
               {
                  "Name":"GrossUnitPriceExcl",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"5"
               },
               {
                  "Name":"Category",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"B2C"
               },
               {
                  "Name":"CareOf",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"John Smith"
               },
               {
                  "Name":"ChamberOfCommerce",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Kvk123456789"
               },
               {
                  "Name":"FirstName",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Test"
               },
               {
                  "Name":"Initials",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"T"
               },
               {
                  "Name":"LastName",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Acceptatie"
               },
               {
                  "Name":"Salutation",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Male"
               },
               {
                  "Name":"Street",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Hoofdstraat"
               },
               {
                  "Name":"StreetNumber",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":90
               },
               {
                  "Name":"StreetNumberAdditional",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"A"
               },
               {
                  "Name":"PostalCode",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"8441EE"
               },
               {
                  "Name":"City",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"Heerenveen"
               },
               {
                  "Name":"Country",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"NL"
               },
               {
                  "Name":"MobilePhone",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"0698765433"
               },
               {
                  "Name":"Email",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"[email protected]"
               },
               {
                  "Name":"BirthDate",
                  "GroupType":"BillingCustomer",
                  "GroupID":"",
                  "Value":"01-01-1990"
               },
               {
                  "Name":"Street",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Afleverstraat"
               },
               {
                  "Name":"StreetNumber",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":80
               },
               {
                  "Name":"StreetNumberAdditional",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"B"
               },
               {
                  "Name":"PostalCode",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"7881ER"
               },
               {
                  "Name":"City",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Leeuwarden"
               },
               {
                  "Name":"CareOf",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"John Smith"
               },
               {
                  "Name":"FirstName",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Test"
               },
               {
                  "Name":"LastName",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"Aflever"
               },
               {
                  "Name":"Country",
                  "GroupType":"ShippingCustomer",
                  "GroupID":"",
                  "Value":"NL"
               }
            ]
         }
      ]
   },
   "CustomParameters":null,
   "AdditionalParameters":null
}

Authorize Response

An additional action is required before the action can be completed. The customer needs to be redirected to the Billink Checkout through the returned redirect URL.

Parameters

Example response

{
    "Key": "7AD43A3B00D347599D9B0CC95D1CCF27",
    "Status": {
        "Code": {
            "Code": 791,
            "Description": "Pending processing"
        },
        "SubCode": null,
        "DateTime": "2025-08-26T10:27:30"
    },
    "RequiredAction": {
        "RedirectURL": "https://testcheckout.buckaroo.nl/html/redirect.ashx?r=9C4C1CB1971B412AAE5D6680EA09F81F",
        "RequestedInformation": null,
        "PayRemainderDetails": null,
        "Name": "Redirect",
        "TypeDeprecated": 0
    },
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "1756196848",
    "ServiceCode": "Billink",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 10,
    "TransactionType": "I069",
    "MutationType": 3,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": "FirstName-Test LastName-Test",
    "PayerHash": null,
    "PaymentKey": null
}

Authorize Push

Parameters

Example push

{
   "Transaction":{
      "Key":"DC268356E5E943C689D3A034XXXXXXXX",
      "Invoice":"TestInvoice 123",
      "ServiceCode":"Billink",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"Success"
         },
         "SubCode":null,
         "DateTime":"2020-11-17T14:10:17"
      },
      "IsTest":true,
      "Order":null,
      "Currency":"EUR",
      "AmountDebit":10.0,
      "TransactionType":"I069",
      "Services":null,
      "CustomParameters":null,
      "AdditionalParameters":null,
      "MutationType":3,
      "RelatedTransactions":null,
      "IsCancelable":false,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":null
   }
}

Capture

Performing this action will start the workflow of a previous authorization. It is only possible to do a full capture.

Capture Request

Parameters

Example request

{
   "Currency":"EUR",
   "AmountDebit":10.0,
   "Invoice":"TestInvoice 123",
   "Description":"TestInvoice 123",
   "OriginalTransactionKey":"DC268356E5E943C689D3A034XXXXXXXX",
   "Services":{
      "ServiceList":[
         {
            "Name":"Billink",
            "Action":"Capture",
            "Parameters":[

            ]
         }
      ]
   },
   "CustomParameters":null,
   "AdditionalParameters":null
}

Capture Response

Parameters

Example response

{
    "Key": "F8EB2B42AB0A49ED83CFE14DXXXXXXXX",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2020-11-17T14:32:16"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "TestInvoice 123",
    "ServiceCode": "Billink",
    "IsTest": true,
    "Currency": "EUR",
    "AmountDebit": 10.0,
    "TransactionType": "C073",
    "MutationType": 1,
    "RelatedTransactions": null,
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "F15DB96A90014011899DCE52XXXXXXXX"
}

Capture Push

Parameters

Example push

{
   "Transaction":{
      "Key":"F8EB2B42AB0A49ED83CFE14DXXXXXXXX",
      "Invoice":"TestInvoice 123",
      "ServiceCode":"Billink",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"Success"
         },
         "SubCode":{
            "Code":"S990",
            "Description":"The request was successful."
         },
         "DateTime":"2020-11-17T14:32:16"
      },
      "IsTest":true,
      "Order":null,
      "Currency":"EUR",
      "AmountDebit":10.0,
      "TransactionType":"C073",
      "Services":null,
      "CustomParameters":null,
      "AdditionalParameters":null,
      "MutationType":1,
      "RelatedTransactions":null,
      "IsCancelable":false,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":"F15DB96A90014011899DCE52XXXXXXXX"
   }
}

Refund

Performing this action will send a refund request to Billink. It is possible to do both partial refunds and full refunds, neither require any article information.

Refund Request

Parameters

Example request

{
   "Currency":"EUR",
   "AmountCredit":10.0,
   "Invoice":"TestInvoice 123",
   "Description":"TestInvoice 123",
   "OriginalTransactionKey":"F8EB2B42AB0A49ED83CFE14DXXXXXXXX",
   "Services":{
      "ServiceList":[
         {
            "Name":"Billink",
            "Action":"Refund",
            "Parameters":[

            ]
         }
      ]
   },
   "CustomParameters":null,
   "AdditionalParameters":null
}

Refund Response

Parameters

Example response

{
    "Key": "5949BAB045174895AF86273AXXXXXXXX",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S990",
            "Description": "The request was successful."
        },
        "DateTime": "2020-11-17T14:42:52"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "TestInvoice 123",
    "ServiceCode": "Billink",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 10.0,
    "TransactionType": "C070",
    "MutationType": 1,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "F8EB2B42AB0A49ED83CFE14DXXXXXXXX"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "95BF1FCA8EC2477798EEF7ABXXXXXXXX"
}

Refund Push

Parameters

Example push

{
   "Transaction":{
      "Key":"5949BAB045174895AF86273AXXXXXXXX",
      "Invoice":"TestInvoice 123",
      "ServiceCode":"Billink",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"Success"
         },
         "SubCode":null,
         "DateTime":"2020-11-17T14:42:52"
      },
      "IsTest":true,
      "Order":null,
      "Currency":"EUR",
      "AmountCredit":10.0,
      "TransactionType":"C070",
      "Services":null,
      "CustomParameters":null,
      "IsCancelable":false,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":null
   }
}

CancelAuthorize

Performing this action will cancel the open authorization with Billink. It is only possible to do a full cancellation.

CancelAuthorize Request

Parameters

Example request

{
   "Currency":"EUR",
   "AmountCredit":10.0,
   "Invoice":"TestInvoice 123",
   "Description":"TestInvoice 123",
   "OriginalTransactionKey":"D8EBB8512AA44E43998FCFE9XXXXXXXX",
   "Services":{
      "ServiceList":[
         {
            "Name":"Billink",
            "Action":"CancelAuthorize",
            "Parameters":[

            ]
         }
      ]
   },
   "CustomParameters":null,
   "AdditionalParameters":null
}