Requests
Requests
The content is currently unavailable in Dutch. You are viewing the default English version.
Article Summary
Share feedback
Thanks for sharing your feedback!
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.
Base JSON request
Use the base request as instructed on this page
Pay request
Note: always make sure the AmountDebit equals the sum of the article amounts
Parameters
Service specific parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Trackandtrace | string | Trackandtrace number from carrier | |
| VATNumber | string | VAT number. | |
| Quantity | string | Yes | GroupType: Article. Article quantity |
| Identifier | string | Yes | GroupType: Article. Article identifier |
| Description | string | Yes | GroupType: Article. Article description |
| VatPercentage | decimal | Yes | GroupType: Article. Article VAT Percentage |
| GrossUnitPriceIncl | decimal | GroupType: Article. Article price including VAT | |
| GrossUnitPriceExcl | decimal | GroupType: Article. Article price exluding VAT. Optional for B2B | |
| Category | string | GroupType: BillingCustomer. Indicator if it is B2B or B2C. Possible values: B2B, B2C. Default value B2B | |
| CareOf | string | GroupType: BillingCustomer. Mandatory for B2B. 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 | string | GroupType: BillingCustomer. Chamber of Commerce number | |
| FirstName | string | Yes | GroupType: BillingCustomer. First name of billing customer |
| Initials | string | Yes | GroupType: BillingCustomer. Initials of billing customer |
| LastName | string | Yes | GroupType: BillingCustomer. Last name of billing customer |
| Salutation | string | Yes | GroupType: BillingCustomer. Gender of billing customer. Possible values: Male, Female, Unknown |
| Street | string | Yes | GroupType: BillingCustomer. Street of billing customer |
| StreetNumber | decimal | Yes | GroupType: BillingCustomer. House number of billing customer |
| StreetNumberAdditional | string | GroupType: BillingCustomer. House number suffix of billing customer | |
| PostalCode | string | Yes | GroupType: BillingCustomer. Postal code of billing customer |
| City | string | Yes | GroupType: BillingCustomer. City of billing customer |
| Country | string | GroupType: BillingCustomer. Country of billing customer. Only required if country is different from NL. Possible values: NL, BE | |
| MobilePhone | string | Yes | GroupType: BillingCustomer. Mobile phone number of billing customer |
| string | GroupType: BillingCustomer. Email of billing customer | ||
| BirthDate | datetime | Yes | GroupType: BillingCustomer. birthdate of billing customer |
| FirstName | string | Yes | GroupType: ShippingCustomer. Firstname of shipping customer |
| LastName | string | Yes | GroupType: ShippingCustomer. Lastname of shipping customer |
| CareOf | string | 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 | string | Yes | GroupType: ShippingCustomer. Street of shipping customer |
| StreetNumber | decimal | Yes | GroupType: ShippingCustomer. House number of shipping customer |
| StreetNumberAdditional | string | GroupType: ShippingCustomer. House number suffix of shipping customer | |
| PostalCode | string | Yes | GroupType: ShippingCustomer. Postal code of shipping customer |
| City | string | Yes | GroupType: ShippingCustomer. City of shipping customer |
Basic parameters
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":"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
}
Pay response
Parameters
Basic parameters
Example response
{
"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"
}
Pay push
Parameters
Basic 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.
Autorize request
Parameters
Basic 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":"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
}
Autorize response
Parameters
Basic parameters
Example response
{
"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
}
Autorize push
Parameters
Basic 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
Basic 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
Basic 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
Basic 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 refund and full refunds, neither require any article information
Refund request
Parameters
Basic 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
Basic 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
Basic 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
Basic 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
}
Was dit artikel nuttig?