Architecture

Authentication

Every API call needs to be authenticated. See the authentication documentation for more details on the authentication process.

Status codes

Generally in our API there are three types of status codes used:

• A 200 status code means that the request was accepted, and there were no issues with it.
• A 422 status code is used whenever there was a validation error with the request. In case of validation errors, they are returned in the errors field.
• A 404 status code is used when the resource you are trying to fetch can not be found.

Rate limiting

When you make request to our API we return in response two headers: X-RateLimit-Limit and X-RateLimit-Remaining. If you exceed the limits you will receive 429 status code alongside with the X-RateLimit-Reset header, which contains a unix timestamp value of when you can safely retry your API call.

Processing Items

The main model of the Glo Currency Partners API is the Processing Item, which store Corridor and Transaction models.

Transactions

Transaction model store the flow for sending money from one Sender in a specific currency, to one Recipient in another currency.

The transaction model stores information about whether the money has already been paid out or not. Any issues during the payout process are also stored against the transaction.