Order

Create order and proceed to checkout

POST https://api.voordemensen.nl/v1/:client_name/order/create

Create a new order and redirect the end-user to the payment provider.

Path Parameters

NameTypeDescription

client_name

string

the short name identifying you as a VdM client e.g. demo or fringe

Request Body

NameTypeDescription

redirectURL

string

the URL the payment provider will redirect the end-user to after payment - we will add the query ?return=order_key to this URL so you can lookup the status of the payment

payment_id

integer

id of payment_method

avg_optin

boolean

opt in for irregular contact regarding this order

avg_mailinglist

boolean

opt in for mailinglist

email

string

email address

firstname

string

first name

lastname

string

last name

phone

string

phone number

address

string

address

city

string

city

zip

string

the zipcode

cart_id

string

the cart_id to check out

[
    { 
        "url": "https://link-to-paymentprovider", 
        "order_key" : "unique-identifier-of-order"
    }

]

Get status of order/payment

GET https://api.voordemensen.nl/v1/:client_name/order/:order_key

Check if the order is paid and display additional info. Use the order_key to find the order. Upon return from the payment provider we will add the query parameter ?response=order_key to the redirectURL (see above).

Path Parameters

NameTypeDescription

order_key*

string

the order_key identifying the order

client_name*

string

the short name identifying you as a VdM client e.g. demo or fringe

Last updated