ShefaPay API (21.2.0)

ShefaPay payments API

Using the API


Authentication is managed using an API key that is provided to you. Every HTTP call to our API should contain a custom header called apiKey. The value of this header must be the API key.

You can find your API key under Developers > API key in our customer login environment.

Currencies and Amounts

To make our platform support all currencies and to prevent rounding errors, amounts are stored as natural numbers, paired with an exponent. This exponent defines at which position the decimal point/comma is placed, counting from the right.

Say we have and amount of $12.34 USD. It will be stored and presented as 1234 with an exponential of 2. Some currencies, like the Japanese Yen, have no exponent. A transaction amount of ¥1,000 JPY is stored as 1000.

Filtering and Searching

Filters can be used to interact with any object. Objects can be queried by appending parameters to the query string of the URL.

So to get a list of all settled US dollar transactions with an amount equal or greater than 75.00, we would use the following URL: