API-verkenner

Theme switcher

Introductie

De Billink API is ontworpen met een RESTful architectuur, en biedt ontwikkelaars een voorspelbare en efficiënte manier om hun applicaties te integreren. De API ondersteunt zowel JSON- als XML-gecodeerde verzoek- en antwoordformaten, waardoor een breed scala aan integratievoorkeuren mogelijk is.

De Billink API biedt een robuuste set van endpoints voor het beheren van belangrijke operaties, waaronder orderafhandeling en betalingsverwerking. De belangrijkste functies zijn:

  • Orderbeheer: Orders aanmaken, in de wacht zetten en hervatten, workflows opstarten,
  • Betalingen: Maak betaalsessies aan, verwerk betalingen en volg de status ervan.
  • Berichten: Stuur updates en berichten over bestellingen.
  • Status bijhouden: Bewaak de voortgang en status van orders en workflows.

Kunt u het eindpunt dat u nodig hebt niet vinden?

We helpen je graag elke werkdag.

Je kunt ons rechtstreeks bereiken via de chat, per telefoon of WhatsApp. Alle details vind je hier.

Om naadloos testen en implementeren mogelijk te maken, biedt de Billink API twee operationele modi:

  • Sandbox-modus: Een veilige testomgeving waarmee u kunt experimenteren met API-functies zonder de live productiegegevens te beïnvloeden.
  • Productiemodus: De live-omgeving voor echte operaties en klantinteracties.

Je kunt onze API Explorer gebruiken om onze endpoints meteen te testen. U kunt altijd schakelen tussen de sandbox- en productieomgeving

API URLs

Billink API biedt twee verschillende omgevingen om ontwikkeling en productie te vergemakkelijken.

Elke omgeving is toegankelijk via een speciale URL:

  • Staging-omgeving: Gebruik deze omgeving voor test- en ontwikkelingsdoeleinden.

URL: https://api-staging.billink.nl

  • Productie-omgeving: Gebruik deze omgeving voor live bewerkingen op productieniveau.

URL: https://api.billink.nl

Zorg ervoor dat je de juiste URL gebruikt, afhankelijk van of je in staging of productie werkt, om onbedoelde interacties met live gegevens te voorkomen

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

Was this section helpful?

What made this section unhelpful for you?

API Versies

De API is beschikbaar in twee versies, Legacy API (v1) en Actuele API (v2), met verschillende gegevensindelingen en mogelijke verschillen in de naamgeving van eindpunten:

Actuele API (v2)

Formaat: JSON Verzoek: Gebruikt JSON voor verzoeken. Antwoord: Geeft antwoorden in JSON-formaat. Endpoint-namen: Endpoints kunnen verschillen in naamgeving van de Verouderde API (v1). Zorg ervoor dat je de juiste documentatie voor v2 raadpleegt.

Legacy API (v1)

Formaat: meestal XML Verzoek: Gebruikt XML voor verzoeken. Antwoord: Geeft antwoorden in XML-formaat. Endpoint-namen: Sommige endpoints kunnen verschillende namen hebben in vergelijking met de Actuele API (v2). Raadpleeg het Legacy API van de documentatie voor specifieke details.

Belangrijke opmerkingen

  • Achterwaartse compatibiliteit: Beide versies bestaan naast elkaar, maar je moet de compatibiliteit met je applicatie controleren voordat je van versie wisselt.
  • Eindpunt URLs: Geef de gewenste versie op in de URL van het eindpunt, bijvoorbeeld:
  • https://api.example.com/v1/endpoint voor Legacy API
  • https://api.example.com/v2/endpoint voor Actuele API

Voorbeeld van Verzoek en Antwoord

Actuele API:

  • URL: https://api-staging.billink.nl/v2/client/invoice/credit
  • Verzoek:
CURL

curl --location 'https://api-staging.billink.nl/v2/client/invoice/credit' \ --data '{ "billinkID": "d38a3439590889df026367bf01ddar621e687b8d278", "billinkUsername": "usertest", "invoices": [ { "creditAmount": 1.5, "description": "test credit", "number": "KRKND-0001" } ] }'

  • Reactie:
JSON

{ "result": "MSG", "statuses": [ { "code": 200, "invoiceNumber": "KRKND-0001", "message": "Credit applied: 1.50 EURO.; step restarted." } ] }

Legacy API:

  • URL: https://api-staging.billink.nl/v1/client/credit
  • Verzoek:
CURL
curl --location 'https://api-staging.billink.nl/v1/client/credit' \ --data '<API> <VERSION></VERSION> <CLIENTUSERNAME></CLIENTUSERNAME> <CLIENTID></CLIENTID> <ACTION></ACTION> <INVOICES> <ITEM> <INVOICENUMBER></INVOICENUMBER> <CREDITAMOUNT></CREDITAMOUNT> <DESCRIPTION></DESCRIPTION> </ITEM> </INVOICES> </API>'
  • Reactie:
XML
Was this section helpful?

What made this section unhelpful for you?

On this page
  • API Versies

Billink Status

Je kunt altijd de actuele status van onze diensten bekijken op:

https://status.billink.nl

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Billink Status

Billink Changelog

Op deze pagina vind je relevante updates aan het Billink-platform: van nieuwe features en verbeteringen in Billink One tot belangrijke bugfixes, API-wijzigingen en nieuwe PSP-integraties. Zo blijf je altijd op de hoogte van wat er verandert en hoe dit jouw checkout, integratie of klantbeleving verbetert.

On this page
  • Billink Changelog

Partners Exclusief

De sectie Clientbeheer is uitsluitend bedoeld voor het aanmaken van e-merchants binnen het systeem. Gebruikers kunnen nieuwe e-merchants registreren door de benodigde klantinformatie te verstrekken. Deze sectie zorgt ervoor dat merchants correct worden aangemeld op het Billink-platform.

Base URL

Production:

Sandbox:

Language Box

Betaling autoriseren

Het onderdeel Beheer van betaalsessies vergemakkelijkt het aanmaken en bewaken van betaalsessies en zorgt voor een soepel en gestroomlijnd betaalproces voor gebruikers. Met dit onderdeel kun je betaalsessies initialiseren en hun huidige status controleren, waardoor je realtime inzicht krijgt in de levenscyclus van de betaling. Deze mogelijkheden zijn essentieel voor het leveren van een veilige en efficiënte betaalervaring.

On this page
  • Betaling autoriseren

Orderbeheer

Het gedeelte Orderbeheer biedt tools voor het afhandelen van de levenscyclus van een order: bewaking, het starten van de workflow, betaling en meer. Het maakt efficiënte orderverwerking mogelijk door middel van functionaliteiten zoals het controleren van de status van een order, het toevoegen van berichten aan orders en het beheren van workflows door orders in de wacht te zetten of te hervatten. Deze functies zorgen voor naadloze integratie, nauwkeurige tracering en gestroomlijnde operaties voor orderbeheer. Houd er rekening mee dat de beschreven eindpunten slechts enkele voorbeelden van foutreacties bevatten. Raadpleeg het gedeelte Fouten voor een uitgebreide lijst met foutcodes en berichten.

On this page
  • Orderbeheer

Reconciliatie

De Reconciliatie-sectie biedt toegang tot financiële gegevens voor het matchen en opvolgen van klantfacturen.

Momenteel worden de volgende functies ondersteund:

  • Ophalen van een paginagewijs overzicht van facturen voor een specifieke Billink-klant
  • Downloaden van factuurgegevens voor verdere verwerking of rapportage
On this page
  • Reconciliatie

Webhooks

Het gedeelte Webhooks biedt eindpunten voor het configureren en beheren van webhook-integraties. Met deze eindpunten kunnen gebruikers en verkopers realtime meldingen ontvangen over betaling sessies en bestellingen door webhook-URL's in of uit te schakelen. Dit maakt naadloze communicatie tussen Billink en externe systemen mogelijk, waardoor automatisering, gebeurtenisgestuurde workflows en verbeterde operationele efficiëntie mogelijk worden.

Gedrag van webhooks

Billink biedt webhook-ondersteuning om verkopers in realtime op de hoogte te brengen van belangrijke updates met betrekking tot sessies en bestellingen.

📬 Retrybeleid

Webhooks worden maximaal 3 keer opnieuw verzonden als de levering mislukt (bijvoorbeeld als de server niet bereikbaar is of een non-2xx statuscode terugstuurt).

Na de derde mislukte poging wordt er een e-mailmelding naar de merchant gestuurd om te waarschuwen voor de mislukte webhooklevering.

On this page
  • Webhooks

Fouten

In Billink API, error responses follow a consistent format. All errors are returned with an HTTP status code 200, which indicates the request was processed but there was an issue with the operation.

The format of the error is as follows:

JSON
{ "code": "000", "description": "Error message", "result": "error" }

  • Code: A unique error code representing the specific issue.
  • Description: A detailed description of the error.
  • Result: Short informative status

These errors might indicate a variety of issues including but not limited to problems with API versioning, client authentication, missing or incorrect parameters, data format issues, and restrictions on actions (such as workflow limitations or invalid operations).

Common Issues:

  1. Client Identification: Errors related to missing or incorrect client username, client id, or API version.
  2. Invoice and Workflow Management: Missing or incorrect invoice numbers or workflow data.
  3. Order Management: Trying to perform actions on orders that are not allowed or are already processed.
  4. Request Limitations: Exceeding request limits (e.g., number of invoices, action frequency).
  5. Parameter Validation: Incorrect or unsupported parameters in requests.

This helps you to easily handle and debug issues by following the provided error code descriptions across all API endpoints.

In the next subsections, you will see errors specific to each endpoint. Each of these subsections includes a list of error codes and their corresponding descriptions to help you understand and resolve issues effectively.

On this page
  • Fouten

Betaling autoriseren

Het betalingsgedeelte Authoriseren is gericht op het aanmaken en valideren van betalingsopdrachten. Het stelt je in staat om een kredietcontrole uit te voeren en een bestelling in te dienen voor verwerking. Deze twee kernacties zorgen voor een veilige, gevalideerde en efficiënte betalingsstroom binnen het Billink-platform.

On this page
  • Betaling autoriseren

Orderbeheer

Het gedeelte Orderbeheer biedt tools voor het afhandelen van de levenscyclus van een order: bewaking, het starten van de workflow, betaling en meer. Het maakt efficiënte orderverwerking mogelijk door middel van functionaliteiten zoals het controleren van de status van een order, het toevoegen van berichten aan orders en het beheren van workflows door orders in de wacht te zetten of te hervatten. Deze functies zorgen voor naadloze integratie, nauwkeurige tracering en gestroomlijnde operaties voor orderbeheer. Houd er rekening mee dat de beschreven eindpunten slechts enkele voorbeelden van foutreacties bevatten. Raadpleeg het gedeelte Fouten voor een uitgebreide lijst met foutcodes en berichten.

On this page
  • Orderbeheer

Fouten

In Billink API, error responses follow a consistent format. All errors are returned with an HTTP status code 200, which indicates the request was processed but there was an issue with the operation.

The format of the error is as follows:

XML
  • CODE: A unique error code representing the specific issue.
  • DESCRIPTION: A detailed description of the error.

These errors might indicate a variety of issues including but not limited to problems with API versioning, client authentication, missing or incorrect parameters, data format issues, and restrictions on actions (such as workflow limitations or invalid operations).

Common Issues:

  1. Client Identification: Errors related to missing or incorrect client username, client id, or API version.
  2. Invoice and Workflow Management: Missing or incorrect invoice numbers or workflow data.
  3. Order Management: Trying to perform actions on orders that are not allowed or are already processed.
  4. Request Limitations: Exceeding request limits (e.g., number of invoices, action frequency).
  5. Parameter Validation: Incorrect or unsupported parameters in requests.

This helps you to easily handle and debug issues by following the provided error code descriptions across all API endpoints.

In the next subsections, you will see errors specific to each endpoint. Each of these subsections includes a list of error codes and their corresponding descriptions to help you understand and resolve issues effectively.

On this page
  • Fouten

Billink merkactiva

Welkom in onze merk toolkit. Hier kun je de logo’s vinden die je kunt gebruiken in jouw webshop. Plaats het Billink logo waar je ook de logo’s van andere betaalmethodes hebt staan. Het logo kun je o.a. plaatsen in de check-out, footer en bijvoorbeeld de productpagina en de landingspages.

Tip: Implementeer de badges en logo's met directe link naar het bronbestand welke wij beschikbaar stellen. Lees meer.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Billink merkactiva

Betaalbadges

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Betaalbadges

Logo lockups

On this page
  • Logo lockups

Kleurcodes

Billink Primary

#FF8D29

rgba(255,141,41)

Billink Primary Light

#FFEEDE

rgba(255, 238, 222, 1)

Billink Pastel Blue

#9ABAE8

rgb(154, 186, 232)

Billink Liliac

#9577AD

rgb(149, 119, 173)

Billink Dark Taupe

#16120D

rgba(22, 18, 13)

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Kleurcodes

Implementatie tips

  • Verwijs direct naar de bron-afbeeldingen die hierboven weergegeven zijn en worden gehost op cdn.billink.nl.
  • Maak bij voorkeur gebruik van de SVG bestanden ivm schaalbaarheid.

We raden aan om de logo's te implementeren met een directe link naar de bron afbeelding zoals wij die hierboven beschikbaar stellen. We hebben hiervoor een zogenaamd CDN (Content Delivery Network) opgetuigd om laadtijden van slechts enkele milliseconden te kunnen garanderen. Het voordeel van een link naar de bronbestanden is dat je altijd gegarandeerd bent van de meest actuele weergave van de logo's en badges in lijn met de laatste merkstrategie van Billink.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Implementatie tips

Billink in je checkout

Om Billink duidelijk te laten weergeven bij de checkout, is het belangrijk om te vermelden dat de klant achteraf kan betalen. Dit staat centraal in hoe we als bedrijf naar buiten communiceren. Gebruik altijd de volgende tekst naast of achter het Billink-logo:

  • Betaal achteraf met Billink
  • Achteraf betalen met Billink
  • Achteraf betalen

Deze formuleringen zijn duidelijk en informeren de klant direct over de mogelijkheid om achteraf te betalen via Billink. Het is essentieel om deze teksten altijd in de checkout weer te geven.

Voorbeeld:

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Billink in je checkout

Heb je een ander formaat nodig?

Heb je een alternatief formaat nodig welke niet op deze pagina staat vermeld of heb je een andere vraag rond de implementatie van de logo's? Stuur een mail naar marketing@billink.nl.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Heb je een ander formaat nodig?

Contactgegevens

Wij kijken uit naar een succesvolle samenwerking.

Mocht je toch niet helemaal uit de integratie komen helpen we je graag. Dit kan op werkdagen via support@billink.nl of via 010 - 414 14 73

Als je nog vragen hebt, kun je hier antwoorden vinden

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Contactgegevens