The API Setup

The PAY Platform setup

We split our product in different sections. Based on the PAY. membership and the level of the developer you can pick the products that you want to implement.

API Package	Package / Requirements	Description	Level	Methods
Transaction Gateway Unit	From PROF +	Start a transaction and redirect the payer to a hosted payment page, directly to the payment method. For Point of sale open the Client information window and Cashier information window.	Junior / Certification not needed for use for own merchant. For Technical product provider. Certification is mandatory.	POST GET
Transaction Operations	From PROF+	Manage individual transactions, change states, capture, void and refund.	Medior / Certification not needed for use for own merchant. For Technical product provider. Certification recommended.	GET PATCH
Payment Processing	From BUS+	Make a direct integration between the merchant or technical supplyer application.	Certification recommended.	POST
Merchant management	Prof +	Update the information of merchants, add and remove data objects	Senior/ Certification not needed for use for own merchant. For ISO's, Alliances and business partners Certification is mandatory.	POST GET PATCH DELETE
Reports & Insights	Corporate	Get dynamic reports via API	Senior	GET
Core DATA	Prof +	Get the basic information of the CORE of PAY that is nessesary to build a smooth payment flow.	Junior / Certification not available for individual merchants. For Technical product provider. Certification is recommended.	GET

HTTP response codes

HTTP-code	Explanation	Body
200 - Ok	The server has processed the request (GET)	Contains the Resources data that can be used in your application. You can check per API the response.
201 - Created	The server has processed the request (POST) Resource has been created.	Resources is CREATED or UNSUSPENDED, Contains the Resources data that can be used to continue your application.
204 - No content	The server has processed the request (DELETE)	No Body
400 - Bad Request	Information was sent in that can not be processed.	Contains the posted Resources that generate errors. Including the error codes to resolve the issue. Check the error code for more information.
401 - Unauthorized	Invalid credentials, please check if authentication-username and password contains valid token or account data.	No Body
403 - Forbidden	No rights to perform this action. You can't request data that is not accessible via the credentials used. Unlike 401 Unauthorized, the client's identity is known to the server.	No Body
404 - Not Found	The server can not find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web.	No Body
405 - Method not allowed	The request method is known by the server but is not supported by the target resource. For example, an API may not allow calling DELETE to remove a resource.	Use GET/POST/UPDATE/DELETE.
406 - Not acceptable	The Accept header format provided by the request is not supported. Check the supported Accept headers	No Body
415 - Unsupported media Type	The Content Type header format provided by the request is not supported. Check the supported Content-Type Header	No Body
422 - Unprocessable Entity	There is an administrative issue that prevent us from processing your request.	Contains information about the issue that should be resolved before you can proceed
429 - Rate limit	You performed too many requests to the platform according to your licence.	Expect the limit and the releasetime?
500 - Server error	The server could not process your request. A message is sent to PAY. monitoring team.	No Body

Accept Headers

Defines how you want to receive the data from the API. If you give a different value as accept header you will get a HTTP 406 response code.

Valid input	Description
Accept: /	You will receive the response in JSON format (default).
Accept: application/json	You want to receive the response in JSON format
Accept: application/xml	You want to receive the response in XML format.

Content-Type Header

Defines how you send the data to the API. If you give different value as content-type header you will get a HTTP 415 response code.

Valid input	Description
Content-type: application/json	You post the data in JSON format.
Content-type: application/xml	You post the data in XML format.