Skip to main content

Introduction

Architecture​

We use a RESTFul approach that requires form encoded JSON objects as a body and returns JSON objects as a response.

Auth​

You need to provide a Authorization: Bearer {key} the header to all your requests to our API, otherwise you will receive a 401 Unauthorized response.

Indempotency Key​

All our API endpoints that create a resource allow you to provide an idempotencyKey parameter that you can generate however you want. If you submit the same create request multiple times with the same idempotencyKey, the first one that was created will be returned with status code 200 OK instead of 201 Created.

Using an indempotency key is our preferred approach to resource creation as it offers a robust interface to battle network/infrastructure issues.

Indempotency keys are indexed on our end and are searchable through the API, this eliminates your need to store the resource ID generated by Orchestrapay.

Localization​

All labels, descriptions and titles are probided in multiple languages, you will find the API endpoints return similar properties:

{
    "title": {
        "key": "display_size",
        "en": "Display Size",
        "ar": "حجم الشاشة"
    }
}

If no translation is available for arabic, you will receive null for the ar property.

You can either display these localized labels directly to your users or you can use the key provided to localize it yourself in your codebase. The key attribute is immutable (it will never change).

Prices​

All prices are expressed as integers in cents, e.g. EGP 175.50 will be shown as 17550 in our responses. Your UI will need to divide this by 100 to display the correct number to the user.