Tegoedbonnen

Huidige versie: 0.1.1

Globaal overzicht

Tegoedbonnen kunnen verzilverd worden bij het maken van online boekingen. Deze documentatie beschrijft het online aanschaffen van tegoedbonnen.

Om de verkoop van tegoedbonnen snel te integreren kun je ook gebruik maken van onze Javascript-library.

Tegoedbon-templates

GET /api2/voucher_templates

Via dit endpoint kunnen de “Tegoedbon-templates” opgevraagd worden die online aangeschaft kunnen worden. Op basis van een Tegoedbon-template wordt een tegoedbon gemaakt.

Voorbeeld request:

GET /api2/voucher_templates HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Voorbeeld response:

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": 1,
    "name": "Klimmen",
    "product_amount": 1,
    "price": 10,
    "expire_days": 365,
    "internal_reference": "online_voucher",
    "pdf_template_id": 12,
    "confirmation_mail_subject": "Uw tegoedbon",
    "confirmation_mail_body": "<p>In de bijlage zit uw tegoedbon.</p>",
    "contactform_id": 2,
    "company_id": 5,
    "products": [
      104,
      105
    ]
  }
]
Status Codes:

Tegoedbon kopen

POST /api2/vouchers/buy

Met dit endpoint is het mogelijk een tegoedbon te kopen

Voorbeeld request:

POST /api2/vouchers/buy HTTP/1.1
Host: demo.recras.nl
Content-Type: application/json

{
   "voucher_template_id":1,
   "number_of_vouchers":3,
   "contact_form": {
      "contactpersoon.voornaam": "Voor",
      "contactpersoon.achternaam": "Naampie",
      "contactpersoon.email1": "api@recras.nl",
      "contactpersoon.telefoon1": "050-2112212"
   }
}
JSON Parameters:

  • voucher_template_id (int) – Verplicht Het id-veld van het te kopen Tegoedbon-template.

  • number_of_vouchers (int) – Verplicht Het aantal te kopen tegoedbonnen. Maximumaantal is 100.

  • producten (array) – Verplicht Een lijst met te boeken boekingsregels, ieder element is een combinatie van een arrangementsregel_id en een aantal.

  • contact_form (object) – Verplicht Ingevuld contactformulier dat hoort bij deze tegoedbon-template. Voor meer informatie, zie de documentatie voor _ContactformulierenSubmit <Contactformulieren opslaan>.

  • redirect_url (URL) – Een URL waar de klant na de betaling naartoe wordt geleid, ongeacht de status van de betaling. Het is dus aan de server waar redirect_url naar verwijst om de status van de boeking te controleren.

Voorbeeld response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "payment_url":"https://mollie.com/some_payment_url",
   "transaction_id":"tr_189481",
   "redirect_url":"https://mywebsite.nl/voucher_thankyou.html"
}
JSON Parameters:

  • payment_url (uri) – De URL waarop de tegoedbon betaald kan worden, de gebruiker moet naar deze pagina gestuurd worden.

  • redirect_url (uri) – De URL waar de gebruiker heen gestuurd zal worden nadat de betaling is voltooid.

  • transaction_id (string) – Een uniek transaction-id.