Introduction Last updated: 2020-04-21
This is a simple documentation for the API that was discussed its main purpose is to document and provide general information not contained on the OpenAPI v2 docs/specification.
This is a simple documentation for the API that was discussed its main purpose is to document and provide general information not contained on the OpenAPI v2 docs/specification.
We have also introduced an automatically generated set of libraries -- TODO --.
These were generated automatically using the OpenAPI v2 specification and the openapi-generator npm wrapper.
A list of possible generators is available here.
In case a different set of libraries auto generated libraries are required - consult the command that was used to generate them -- TODO link -- for more information contact us
Authorization is done via basic auth.
The credentials used: live/test mode have an impact on the objects that are created, and for the webhooks - a sha hmac validation is used
Both the live and test mode have the following credentials:
The credentials use (either the live or test ones) will have an impact on the Merchant's testMode parameter
Two webhooks are called on the destionation:
Every request contains a x-gateway-hmac-sha256 header with a base64 string of a HMAC Sha256 of the raw body of the request
This HMAC is signed using the webhookSecret detailed above
.Example code to validate the request below:
Given OpenAPI's v2 specification limitations (and the inability to easily use v3 with Callbacks) - the data structures are provided below:
Some examples of invocations of the MerchantStatuscan be seen here - Webhook Secret used: asldslakjdkj123lkj123
Examples of TransactionInfo invocations should be made available soon
Usage of a website like Webhook site is highly recommended
Upon creating a Merchant - the MerchantStatus webhook is already called
To be able to allow testing of the TransactionInfo webhook you can use the following site:
This API was developed using OpenAPI v2 Specification - which permits automatic creation of documentation/client stubs - etc.
The automatically generated documentation can be accessed here