General

Billink is a flexible pay-later payment method. Billink will handle the entire invoicing process, while guaranteeing the payment. Billink supports both B2C as B2B transactions.

Pay

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

View in playground

Request


JSON gateway request

Note: always make sure the AmountDebit equals the sum of the article amounts

Trackandtrace

Trackandtrace number from carrier

VATNumber

VAT number. Required for B2B

Quantity
Required

GroupType: Article. Article quantity

Identifier
Required

GroupType: Article. Article identifier

VatPercentage
Required

GroupType: Article. Article VAT Percentage

GrossUnitPriceIncl

GroupType: Article. Article price. Required for B2C

GrossUnitPriceExl

GroupType: Article. Article price. Required for B2B

Category
Required

GroupType: BillingCustomer. Indicator if it is B2B or B2C. Possible values: B2B, B2C

CareOf

GroupType: BillingCustomer. Name of intermediary who is 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.

ChamberOfCommerce

GroupType: BillingCustomer. Chamber of Commerce number

FirstName
Required

GroupType: BillingCustomer. First name of billing customer

Initials
Required

GroupType: BillingCustomer. Initials of billing customer

LastName
Required

GroupType: BillingCustomer. Last name of billing customer

Salutation
Required

GroupType: BillingCustomer. Gender of billing customer. Possible values: Male, Female, Unknown

Street
Required

GroupType: BillingCustomer. Street of billing customer

StreetNumber
Required

GroupType: BillingCustomer. House number of billing customer

StreetNumberAdditional

GroupType: BillingCustomer. House number suffix of billing customer

PostalCode
Required

GroupType: BillingCustomer. Postal code of billing customer

City
Required

GroupType: BillingCustomer. City of billing customer

Country

GroupType: BillingCustomer. Country of billing customer. Only required if country is different from NL. Possible values: NL, BE

MobilePhone

GroupType: BillingCustomer. Mobile phone number of billing customer

Email

GroupType: BillingCustomer. Email of billing customer

BirthDate
Required

GroupType: BillingCustomer. birthdate of billing customer

FirstName
Required

GroupType: ShippingCustomer. Firstname of shipping customer

LastName
Required

GroupType: ShippingCustomer. Lastname of shipping customer

CareOff

GroupType: ShippingCustomer. Name of intermediary who is 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.

Street
Required

GroupType: ShippingCustomer. Street of shipping customer

StreetNumber
Required

GroupType: ShippingCustomer. House number of shipping customer

StreetNumberAdditional

GroupType: ShippingCustomer. House number suffix of shipping customer

PostalCode
Required

GroupType: ShippingCustomer. Postal code of shipping customer

City
Required

GroupType: ShippingCustomer. City of shipping customer

Country

GroupType: ShippingCustomer. Country of shipping customer. Only required if country is different from NL. Possible values: NL, BE

JSON

copy
{
   "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":"VatPercentage",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Seven"
               },
               {
                  "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":"billingcustomer@buckaroo.nl"
               },
               {
                  "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
}

Response


JSON gateway response

JSON

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

Push


JSON push response

JSON

copy
{
   "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.

View in playground

Request


JSON gateway request

JSON

copy
{
   "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":"VatPercentage",
                  "GroupType":"Article",
                  "GroupID":"1",
                  "Value":"Seven"
               },
               {
                  "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":"billingcustomer@buckaroo.nl"
               },
               {
                  "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
}

Response


JSON gateway response

JSON

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

Push


JSON push

JSON

copy
{
   "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.

Response


JSON gateway response

JSON

copy
{
    "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"
}

Push


JSON push

JSON

copy
{
   "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 refund and full refunds, neither require any article information

Response


JSON gateway response

JSON

copy
{
    "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"
}

Push


JSON push

JSON

copy
{
   "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.

Response


JSON gateway response

JSON

copy
{
  "Key": "DB4148D5B2574CF8A7848FBEXXXXXXXX",
  "Status": {
    "Code": {
      "Code": 190,
      "Description": "Success"
    },
    "SubCode": null,
    "DateTime": "2020-11-17T15:12:00+01:00"
  },
  "RequiredAction": null,
  "Services": null,
  "CustomParameters": null,
  "AdditionalParameters": null,
  "RequestErrors": null,
  "Invoice": "TestInvoice 123",
  "ServiceCode": "Billink",
  "IsTest": true,
  "Currency": "EUR",
  "AmountCredit": 10.0,
  "TransactionType": "I072",
  "MutationType": 1,
  "RelatedTransactions": null,
  "ConsumerMessage": null,
  "Order": null,
  "IssuingCountry": null,
  "StartRecurrent": false,
  "Recurring": false,
  "CustomerName": null,
  "PayerHash": null,
  "PaymentKey": null
}

Push


JSON push

JSON

copy
{
   "Transaction":{
      "Key":"DB4148D5B2574CF8A7848FBEXXXXXXXX",
      "Invoice":"TestInvoice 123",
      "ServiceCode":"Billink",
      "Status":{
         "Code":{
            "Code":190,
            "Description":"Success"
         },
         "SubCode":null,
         "DateTime":"2020-11-17T15:12:00"
      },
      "IsTest":true,
      "Order":null,
      "Currency":"EUR",
      "AmountCredit":10.0,
      "TransactionType":"I072",
      "Services":null,
      "CustomParameters":null,
      "AdditionalParameters":null,
      "MutationType":1,
      "RelatedTransactions":null,
      "IsCancelable":false,
      "IssuingCountry":null,
      "StartRecurrent":false,
      "Recurring":false,
      "CustomerName":null,
      "PayerHash":null,
      "PaymentKey":null
   }
}