API codes

This section includes a description of every API code used in the Payouts API, check below for:

Payout status

The Payout status can take one of the following values:

Code

Description

Description

0

Pending

The payout is received to be processed in the next cut off

1

Completed

The payout was completed

2

Cancelled

The payout was cancelled

3

Rejected

The payout was rejected by the bank

4

Delivered

The payout is being processed by the bank.

5

On hold

The payout is on hold by the merchant or awaiting for further legal information to be processed

Error codes range

Description

Code range

Syntax validation in parameter/s

3xx

Merchant identification validation

4xx

Business logic validation

5xx

Semantic validation in parameter/s

6xx

Transactional error

7xx

Rejection error (only API Version 2.0)

8xx

Different error codes types can be seen below:

Syntax codes reference

Code

Description

300

Invalid params + [param name] + [reason]

301

Empty params + [param name]

302

Invalid control string

303

Invalid bank code

Merchant identification validation

Code

Description

401

Invalid credentials

402

Unregistered IP address

(register is in merchant's panel)

Business logic validation

Code

Description

507

Country not found for payouts

508

Limit exceeded + [limit name]

509

Payout not found with this ID

510

Invalid status: payout is not Pending

511

External ID already used

512

Rejected compliance limits

513

End beneficiary blacklisted

514

Insufficient funds

Transactional error

Code

Description

702

Could not cancel the payout

703

Could not make the payout

Rejection error

Code

Description

800

'ERROR_ACCOUNT_INCORRECT'

801

'ERROR_ACCOUNT_CLOSED'

802

'ERROR_AMOUNT_INCORRECT'

803

'ERROR_BANK_INVALID'

804

'ERROR_BANK_BRANCH_INCORRECT'

805

'ERROR_BENEFICIARY_DOCUMENT_ID_INVALID'

806

'ERROR_BENEFICIARY_NAME_INCORRECT'

807

'ERROR_REJECTED_BY_BANK'

808

'ERROR_OTHER'

809

ERROR_ACCOUNT_TYPE_INCORRECT

810

ERROR_ACCOUNT_NOT_MATCH_BENEFICIARY_DOCUMENT

811

ERROR_ACCOUNT_NOT_MATCH_BENEFICIARY_NAME

812

ERROR_ACCOUNT_NOT_ACCEPT_TRANSFERS

813

ERROR_BENEFICARY_DOCUMENT_NOT_MATCH_NAME

814

ERROR_ACCOUNT_OF_OTHER_CURRENCY

815

ERROR_REJECTED_BY_COMPLIANCE

816

ERROR_REJECTED_BENEFICIARY_BLACKLISTED

817

REJECTED POST APPROVAL

819

ERROR_INCORRECT_WALLET_KEY

Purpose codes reference

Some countries' bank compliance processes require you to specify each payment's purpose:

Code

Description

EPFAMT

Family maintenance

ISMDCS

Payment for medical care services

ISSTDY

Payment of study/tuition costs

ISCHAR

Payment for charity reasons

EPPROP

Payment of property purchase

EPSHAR

Payment of shares

EPIVST

Payment of an investment

ISUBIL

Payment to common utility provider

ISTAXS

Payment of taxes

EPTOUR

Tourism

ISSAVG

Payment to savings/retirement account

ISPENS

Pension payment

ISPAYR

Payment of payroll

ISGDDS

Purchase sale of goods

ISSUPP

Supplier payment

EPREMT

Remittances

ISSCVE

Purchase sale of services