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.

Remitter

The senders model stores information about who sends the money for the transaction. Only senders that are KYC’d are allowed to pay in money.

If your site already does KYC on the senders, then let us know as we might waive the requirement to send us sender documents to ease the usage of our API. Please also check our KYC documentation for more info.

As with transactions, external IDs should be included for senders when a transaction is created. If this ID already exists in our system, any details sent along with the external ID are used to update the sender.

You can read more on senders in the transaction flow documentation.

Beneficiary

The recipient model stores information about who receives money from a transaction.

You can read more on recipients and how they work during transactions in the transaction flow documentation.

Transactions

The main model of the korimoneytransfer API is the Transaction, which 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.

You can read more on transactions in the transaction flow documentation.