Introduction

Aricos is middleware that is make transfer transaction easy, fast, secure, reliable and accessible from all around the World. We provide simple APIs which you can use to send money to all banks in Indonesia quickly and securely.

Aricos is organized around REST. We use built-in HTTP features and HTTP verbs and we return all responses in JSON.

Bank Account Remittance Overview

Use the Remittance API to transfer funds instantly to any bank in Indonesia at any time, including holidays and weekends. Due to restrictions from the banks, we’re unable to disburse when the bank channel are offline or when they fail.

The remittance flow is as follows:

Prefund your Aricos account balance
Create a customer which represents the sender, and a customer which represents the recipient of the remittance. You’ll get an id for each
Create a remittance, attaching ids of the sender and recipient
We run this remittance through our risk-scoring system. If necessary, our compliance team will contact you for additional verification of information
We process the remittance and return a callback with the status of the remittance. You may also query the status of a remittance anytime via the Get Remittance API

Getting Started

Set Up Your Account

To use our Bank Account Remittance APIs, register for an Aricos account by contacting your account manager or our support team.

You can start testing our APIs immediately in development environment. When you are ready to process live transactions, contact your account manager to go live.

Retrieve Your API Account

Before you access all our features, you have to register your account to access all our API Feature. Our support team will give you the information of your account to login into our API.

To successfully authenticate with Aricos's API, you must append a colon and Base 64 encode the API key. All API requests should be made over HTTPS instead of HTTP (all calls made over plain HTTP will fail).

You can access our end-point url to:

Info	Url
Development	https://dev-bankaccount.aricos.co.id
Production	https://bankaccount.aricos.co.id

Start Testing!

You may test our APIs by sending requests in the development environment--You will automatically get IDR balances in your development account balance for testing. Requests made in the development environment will not hit the banking networks and will not cost you anything.

Postman Collection

The easiest way to get started using our API is to use our Postman Collection. Postman is a free client application that enables you to make calls to APIs easily. To make integrating with our APIs easier, we've created a Postman Collection of our endpoints so that you can test our APIs more easily.

The following is an outline of actions to get started with Postman.

Install Postman.
Download our Postman collection.
Open Postman and Import the Aricos API Postman Collection.
Set up the collection’s Authorization header.

a. Under the Authorization tab of each folder, the default authorization type is set to “Inherit auth from parent”. The “Inherit auth from parent” setting indicates that every request in the folder by default uses the authorization type from the parent.

b. Edit the Aricos API collection.

c. Under “Authorization”, paste your secret API key into the Username. Use your Development Key to test in the development environment, and your Live Key to send live transactions.

d. Click Update.

e. This authorization key will be automatically used for each request in the collection.
Try getting your balance.

a. Click on the Balances folder and click Get Balances.

b. Hit the blue Send button.

c. In the response area, you should get your latest cash balance.
If you can query your balance successfully, you’re all set up! Feel free to explore our other APIs by selecting it in the collection and launching it.

Account

Account Register

All information about your account and password will be provide by our support team by email. So if you're not getting any information about your account for development testing or for go live, please let us know.


POST https://dev-bankaccount.aricos.co.id/oauth/token

You have to login to get token access before you do a request to our APIs. You have to keep every token from our request response every time you want to access another request.

Login Example Request:


curl --location --request POST 'https://dev-bankaccount.aricos.co.id/oauth/token' \

--header 'Accept: application/json' \

--form 'grant_type="password"' \

--form 'password="password"' \

--form 'username="user@mail.com"' \

--form 'client_id="94c92649-ae06-4f6e-b03b-b5a4327d0a50"' \

--form 'client_secret="te4hNdxm9BM8eRcG4AQMDes4GLQt0ujPbS5d8CHR"'

Make sure to replace username and password with your account credential.

Parameter	Description
grant_type	Grant Type To Generate Token And Fix Value
username	The User Account That Provided By Our Team
password	The User Password That Provided By Our Team
client_id	The Client ID That Provided By Our Team
client_secret	The Client Secret That Provided By Our Team

Make sure to replace username and password with your account credential.

Login Example Response:


{

"token_type": "Bearer",

"expires_in": 31536000,

"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiI1NmU3ZTUyZGQ3ZGNmOTBiM2Q3MDFkY2M5MTVmYzFmYWU2YWFjMjAwNjg1Mjc0ZmI2MThiZjY0ZGZhZmVlY2M1MTEwOGI1OTg4YzIwNTkwNiIsImlhdCI6MTY0MjA2NTU3OS4wNTU1ODksIm5iZiI6MTY0MjA2NTU3OS4wNTU1OTgsImV4cCI6MTY3MzYwMTU3OS4wMjM4NTUsInN1YiI6ImFlMzYwZjk2LWNkMjYtNGVlYy1hNzFlLTk1MTZkN2YzZjUwYSIsInNjb3BlcyI6W119.rgeLHfR97_ntN3lwdfUbM2XqxMGQ8jHXjYYvaXGpsp-JVc9MFPVv-_x9mNE_9JguPV1eyOVrCO2Rsf6RT9VRpLYShZ1bDt4ZFCkJ6GC_iE7rL8GIzdNxXCOOuCmDT8u1L_V6y81f9jdMYfLqtDgU54EFoPTZbIRD9-NPshtzM3bkGLT8PomKdJw5_-fUnuYIsZ3alh8j8hdZ2Yl1nthiBoF4vMBKjRG3SJbex3Rb08Lyy11J6lT26dDcLMMKTHqBIYarfwHdZtJs-qHJxg1Ne142y4L4g_jcAjQ-eVR7EcGWaMDN-3yqqEyX1tlcYkd-d4FcFYxWv6kuZ7y8LuXMUtYgXWlrb8ntcpEvviESVTmK9RN3l26Tmz_-QPVaJMdGJ0tljiS29LIm13kabps0Uav8AR0C3dA7S7XZm2FlaKwBtBunOguO4yIvY4dHuEkFuKcCr5GHFdFgsGWDX6LjBuYxRL9KUaas_gTHvMlMGeAaM7n5w55F44SAWNgZyvvEGciwMW0uOYHr9a1RNUiBafmAsDFpoO7FUu-lrUom2VLzfXWuIZF8sOV4rJRdas5vDwOZTBcMSt7fSUtpR2HdOzAw0MR5hsMYWCV9TjeWTiRGgBXZvE1j6LuD-22idsaInVFrCENyO9jsmrSs7GPLHlkYXDV0-wmZCDoOP1nnQk4",

"refresh_token": "def50200325bd991fab946343ce6c945a498696fce7d15c2b70c8354e5266e595f2853ffdfcd8b918b6c3eba922bd870f1f493bf3803611bd7329512a48d8448524f96a7ec85c984676c7a3856ef5e67cd3cd02fc58235e728cbfd656c43c261a153122804791ba5a31588f3ecbd03b79996aa5b688a3f053fb0b929acba44164cd5df70b8068a871e3fb746f59032d79c81187e4e5c59eb029b562f62f142ab83dbd4b462dd904a44ed6195c89be2996a79702a27b6a5468a1b2cb48abe52b160c243f3790c99cb67dd85e60d1c0e809b22129cbb9fd2f5f36d7468d78d38d77ae8167c49ba8db12c8fc55b94b92cee0d6b85e64a32c575d43953683403a068845bdf06ae6277b0013999d286fe28216726ab85170ab726c7bdb8c4a5fec361a651ec4e984c1ba262b2d755a6206380c6cd5b2f38744a89c8205ceea0760059ac47d67ffc1d358b31fe9516373d652afa396ca9fde9c4f912c0b0bd790a284cbbd5885ffecb88567cd2949b85d0d6853798d63c58812dabeeb59767f81e4a2da0b0b888e3f908fd8ce148eec28ed1f12f889b3798dbf0772486346dced260e0f32d5ba8f1380279d6"

}

Parameter	Description
expires_in	User Validity Period Time To Access Our API
access_token	Bearer Token That You Have To Use Everytime When You Want To Access Our APIs

Balance

Prefund Your Balance

Your balance refers to stored value in your Aricos account which can be sent out in remittances or withdrawn. Before you do any remittances, you will first have to add to your account balance ("prefund"). You can do this by transferring funds to Aricos's bank accounts. You can will get information about our bank account from our team so you can do prefund. After you have transferred the funds, please save the proof of transfer.

If you have prefunding to your account, the balance should be detected and updated in your account in 15-30 minutes. If prefunding failed or have technical issues, please contact our support team with the proof of transfer to complete the prefund.

Get Balance


GET https://dev-bankaccount.aricos.co.id/api/user-balances

Retrieves your account balance. There are two balances: CASH refers to funds available for you to remit or withdraw. HOLDING refers to funds which are in transit.

Get Balance Request

Get Balance Example Request:


curl --location --request GET 'https://dev-bankaccount.aricos.co.id/api/user-balances' \

--header 'Accept: application/json' \

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiJiZTcwMTJjZWIyOTNiYTJlMWNlZDE0MWI0YmZiZWExNzA5MmNiZjI5NTIyNTQzOWMyZDMzY2E4N2YwMjVmZDQ4ZTg0NTc5OGI2N2YzNWRmNiIsImlhdCI6MTY0MjY3NTYyMC42NTQ3MywibmJmIjoxNjQyNjc1NjIwLjY1NDczNywiZXhwIjoxNjc0MjExNjIwLjYzODE4OSwic3ViIjoiYWUzNjBmOTYtY2QyNi00ZWVjLWE3MWUtOTUxNmQ3ZjNmNTBhIiwic2NvcGVzIjpbXX0.faK3IffH8w5R7EEIscvnYbnhn9uQMS6206TEovhP9lgh1XUD6PubsPiyYtPWyCo_NhO-RzRI_8CHpKaMTPK9hLRUvAeNpV2CjUmM3GG2HSmgwC5a863IJoGvaGSL90aBtw-Ub3DBv1dzn00_-98982o-gSKHElsgf1o0EYGA1Y7vXEdEfN45Eww5rFG2cVUyKQo_eh8J8aITQQ15xydDsWe1lFPYYqrDIfZ6xTNa00b-GYP-DIVHP1NOYPdihOKPgt4uSzb03vfu62PFYzlR2gQiodW7Ellf-5-kIrGVRbogcZzTnBw41yKm7jU9hxx5hLgfEB5sImBMRcihER4W4GM5fLmpVQHmlOT9hTCQrtr__XEZK481OrZ75TsEYE0oaAygP2qMrlGgMYPxXvtsF9jLOrIzSmBx16mV7OeV1hytgot2KcppO-5hui5UI1kRuSY-YIY8I0y7AGX74Sq3SGQnvnesF0r5LbrxZiGP1pDUKHmn37O0SFYXT1QNEJPwwkMwVHmqsaggrl0QNejCXQRNr2eQHc1zq5umw1oTDvoxQhHTfmtyJx3zGYhKfQckoULUZs79Z0MXsqVB1n_8fFxymdagoI2EVMQ-geb0k8a9VdXTffXzAcEMD4z7ZUhx56jnNYJz62R-ZNtkxrMAOsjS3tfMje7WKoRhgOJ4HKY'

Our get balance end-point doesn't have any body request just send the BEARER TOKEN as auth

Get Balance Response

Get Balance Example Response:


{
    "data": [{
        "id": "ae360f96-cd26-4eec-a71e-9516d7f3f50a",
        "email": "argjkt2@gmail.com",
        "name": "ARG_OTR",
        "balance": 8288000,
        "on_hold_balance": 870000
    }],
    "links": {
        "first": "https://dev-bankaccount.aricos.co.id/api/user-balances?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://dev-bankaccount.aricos.co.id/api/user-balances",
        "per_page": 15,
        "to": 1
    }
}

Parameter	Description
id	The unique identity of your account
email	The user account that you use
name	The user name of your account
balance	The real balance that you can use to transfer remittance
on_hold_balance	The retained balance from accumulation of every unfinished transaction

Customers

Customer Data

Customers are your end-customers, which include the sender and recipient of a remittance. You can perform recurring remittances with the same customers.

Use the following Customers API to manage your customers with Aricos. Your customers’ personal data is retained to comply with regulatory requirements for fund transfer services in Indonesia, and also allows Aricos to fulfill Know-Your-Client obligations.

Create Customer Request


POST https://dev-bankaccount.aricos.co.id/api/customers

Create customer for your end-customers for the sender and recipient.

Create Customer Example Request:


curl --location --request POST 'https://dev-bankaccount.aricos.co.id/api/customers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiJjNWMxNzVjMDAwOTE3ZjM3NmFlODQxN2YyNzExNzM0YzEyZTExYmIxOGNkNzBlYTMzZjRiMzM5MThmODQ5ZGIwMWMyNTA4ODI0NWEzN2M1NyIsImlhdCI6MTY0MjczMzE2Mi4yMTg2NTksIm5iZiI6MTY0MjczMzE2Mi4yMTg2NjcsImV4cCI6MTY3NDI2OTE2Mi4xOTA4NzUsInN1YiI6ImFlMzYwZjk2LWNkMjYtNGVlYy1hNzFlLTk1MTZkN2YzZjUwYSIsInNjb3BlcyI6W119.SSWzHI2hOKtWDzzwUCTqrZzs7uXK132BXmw5h_yDkIpAKQa91TdxdMTU-VhWMunmsQ8aAHRB2tlj-lyQk5P1XYXqeXCpajKgLHIL-P-r7PkXdHQmg8l8qamy_Vrz26zCtuSgD7YhqaTax7IxEXQL4mR9ixZnJ2wvUWz-lDIV0AbxxB5uQqspYcq-8kRjgMEr_wJvPcNW7gg9cPpznHIMcKP5XKpjjzvkn0LxKDkVB5mnAESpknchTdaMIeqFRQ_u3-kLuIm3Qp7Ri-4iiDY4I0N0MqGH93i-W-bOeF_MVI-CIa0AwLuBac-7gnsCVoxfi5QwJrs-pf1VbwsTTw6RSyxnFhp_DDiwC2pZFkoeyIu5hqPgq-u40wWsdHhCmXrurZJVntRDeMER_aC6nIo5WrMxSb_taqYLrzxuQ_ytht8N9ftkcIGt12xpp10jMcNzpECs5Of1Oc8cz5GudgkwOCpX98btstkVYjG-nu_QU0FI_Fxpv-XGGBJ6sbR9ZY96FRBLmjMfUEX7HPQ-HDo44TonabBvv0UhiEbTTYYman0F9PHWRctuc5Xi31m8fnWpOlRcr5dHKmOqxa2YTZgSzhMsZw2gAOXhmH49ef4TNm3ly2bbMHZqDcx6GwTa-rdIK2TZ4uXU9MwZ6fWliu3O5oKOYu2dcLQLBZyeN_BOPak' \
--data-raw '{
    "reference_id": "x-7986",
    "customer_type": "INDIVIDUAL",
    "given_name": "Cika Jerika",
    "surname": "Cijer",
    "nationality":"ID",
    "gender": "Female",
    "occupation":"OTHER",
    "address": {
        "country_code": "ID",
        "province_id": "31",
        "city_id": "3171",
        "line_1": "Jl. Senayan 1 No.15",
        "line_2": "Komplek BNI",
        "postal_code": "16320"
    },
    "date_of_birth": "11-01-1990",
    "place_of_birth": "Prabumulih",
    "identifications": [
        {
            "identification_type": "ktp",
            "identification_country": "ID",
            "identification_number": "1025456545454545"
        },
        {
            "identification_type": "npwp",
            "identification_country": "ID",
            "identification_number": "254545465425489"
        }
    ],
    "account_details": {
        "account_code": "BNI",
        "account_number": "123456789",
        "account_holder_name": "Cika Jerika"
    },
    "email": "cijer@email.com",
    "mobile": {
        "country_code": "62",
        "number": "08111555777"
    },
    "phone": {
        "country_code": "62",
        "number": "02199990000"
    },
    "fax": {
        "country_code": "62",
        "number": "02199991111"
    }
}'

Parameter	Description
reference_id required	`string` Your unique id for this customer. `Characters` Special and alphanumeric Maximum length 100 maximum characters
customer_type required	`string` Legal entity. Valid values: `INDIVIDUAL` or `BUSINESS`
given_name required	`string` Given name(s). Mandatory for `customer_type` is `INDIVIDUAL` and `BUSINESS`
surname required	`string` Surname or family name or last name. Only allowed if `customer_type` is `INDIVIDUAL`
nationality required	`string` Nationality country of the Customer. 2-letter ISO 3166-2 country code. Refer to code standard here
gender required	`string` Gender of the Customer. Only allowed `Male` or `Female` value
occupation required	`string` Occupation of the Customer. See Occupation Codes
address optional	`object` Customer's address
address.country_code required	`string` Customer’s country. 2-letter ISO 3166-2 country code. Refer to code standard here. If `customer_type` is `BUSINESS`, the country in which the corporate entity is registered. If `customer_type` is `INDIVIDUAL`, a country in which the customer holds nationality
address.province required	`string` Customer’s province. Download list here
address.city required	`string` Customer’s city. Download list here
address.district optional	`string` Customer’s district. Download list here
address.village optional	`string` Customer’s village. Download list here
address.post_code optional	`string` Customer’s postal code
address.line_1 optional	`string` First line of customer’s address. Typically used for building name and / or apartment number
address.line_2 optional	`string` Second line of customer’s address. Typically used for building name and / or apartment number
date_of_birth optional	`string` Date of Birth. Only allowed if `customer_type` is `INDIVIDUAL`. ISO 8601 format YYYY-MM-DD
place_of_birth optional	`string` Place of Birth. Only allowed if `customer_type` is `INDIVIDUAL`
date_of_registration optional	`string` Date of Registration. Only allowed if `customer_type` is `BUSINESS`. ISO 8601 format YYYY-MM-DD
identifications required	`object` A legal document that verifies the identity of the customer
identification.identification_type required	`string` Type of identity of the customer. See Identification Codes Only allowed value `KTP`,`NPWP`,`SIM`,`PASSPORT`,`OTHER` `Characters` 10 characters
identification.identification_country required	`string` Country identity publisher of the customer. 2-letter ISO 3166-2 country code. Refer to code standard here. `Characters` 2 characters
identification.identification_number required	`string` Identification number of the customer. `Characters` 15 characters for `NPWP`, 16 characters for `KTP` and other identification type
account_details optional	`object` Customer’s bank account details
account_details.account_code optional	`string` The code of the account, can be bank codes (BCA, MANDIRI, etc.) or ewallet codes (GOPAY, OVO, etc.). Only Indonesian banks and ewallets supported currently. See Account Codes
account_details.account_number optional	`string` Destination bank account number. If disbursing to an e-wallet, phone number registered with the e-wallet account. `Characters` Numeric and hyphens `BCA required length` 10 characters `Other banks maximum length` No maximum characters `Other banks minimum length` 1 character `E-wallets` Phone number registered with the e-wallet(Example: 0812XXXXXX) * We support remittances to virtual accounts of major banks (BRI, BNI, Mandiri, CIMB Niaga, Permata, BTN, and NOBU Bank). * We support remittances to major e-wallets (GoPay, OVO, and Mandiri e-cash).
account_details.account_holder_name optional	`string` Name of account holder per the bank's or e-wallet's records `Characters` Special and alphanumeric `Maximum length` No maximum characters `Minimum length` 1 character
email optional	`string` Customer’s email address. Recommended if you want to notify the customer of the transaction statusShould include the top-level domain name Example: abc@email.com
mobile conditionally required	`object` Customer’s mobile number. Required for `Recipient` in `Cash Pick Up` transaction.
mobile.country_code conditionally required	`string` Customer’s mobile number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62. Required for `Recipient` in `Cash Pick Up` transaction.
mobile.number conditionally required	`string` Customer’s mobile number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX. Required for `Recipient` in `Cash Pick Up` transaction.
phone optional	`object` Customer’s phone number.
phone.country_code optional	`string` Customer’s phone number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62
phone.number optional	`string` Customer’s phone number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX
fax optional	`object` Customer’s fax number.
fax.country_code optional	`string` Customer’s fax number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62
fax.number optional	`string` Customer’s fax number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX

Create Customer Response

We return a customer object if the call succeeded.

Create Customer Errors

Create Customer Example Response:


{
    "data": {
        "id": "9564d7a6-f5d3-4dd4-911f-4d13144e8311",
        "reference_id": "x-89456",
        "customer_type": "INDIVIDUAL",
        "given_name": "Thomas Djorgi",
        "surname": "Thomdjor",
        "gender": "Female",
        "occupation": "OTHER",
        "fax": {
            "country_code": "62",
            "number": "02199991111"
        },
        "address": {
            "country_code": "ID",
            "province_id": "31",
            "city_id": "3171",
            "line_1": "Jl. Senayan 1 No.15",
            "line_2": "Komplek BNI",
            "postal_code": "16320"
        },
        "date_of_birth": "11-01-1990",
        "place_of_birth": "Prabumulih",
        "nationality": "ID",
        "identifications": [
            {
                "identification_type": "ktp",
                "identification_country": "ID",
                "identification_number": "1025456545454545"
            },
            {
                "identification_type": "npwp",
                "identification_country": "ID",
                "identification_number": "254545465425489"
            }
        ],
        "account_details": null,
        "email": "tomdjor@email.com",
        "mobile": {
            "country_code": "62",
            "number": "08111555777"
        },
        "phone": {
            "country_code": "62",
            "number": "02199990000"
        }
    }
}

Error Code	Description
API_VALIDATION_ERROR 400	Inputs are failing validation. The errors field contains details about which fields are violating validation No retry
INVALID_JSON_FORMAT 400	The request body is not a valid JSON format No retry
ACCOUNT_CODE_NOT_SUPPORTED_ERROR 400	The code of the account is currently not supported No retry
ACCOUNT_NUMBER_ERROR 400	Where account_code is “BCA”, account_number input needs to be 10 digits. Please check the account number length before retrying. No retry
DUPLICATE_CUSTOMER_ERROR 400	The external_id entered has been used before. Please enter a unique external_id and try again. No retry

Update Customer Request

Updates an existing customer


PUT https://dev-bankaccount.aricos.co.id/api/customers/{reference_id}

Update Customer Example Request:


curl --location --request PUT 'https://dev-bankaccount.aricos.co.id/api/customers/c-01256' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5MzFmODI3Ni1mOTBmLTQ0N2ItYjY0ZS1hMjI3MzQxOGVkMzIiLCJqdGkiOiIwYmE2NDcwMTNjYjE2ZTRmYjNhN2RjMGNkYTEyYjk0ZjkwZjExZmE0OWJjN2NjMDdlMmU4MjhlYzQ1MDkxYmM0NDljYjM0ZmQ0ZjVmNWIzNiIsImlhdCI6MTY0MjczOTQxMi44MzE3MjksIm5iZiI6MTY0MjczOTQxMi44MzE3MzYsImV4cCI6MTY3NDI3NTQxMi44MjI3NTQsInN1YiI6IjVhOWEyOGM2ZDRlOGMxMmFkMCIsInNjb3BlcyI6W119.X9hh_rPgAnlreqXZ-CuG-cIub0ihQc1EBNFBluCpcZcAaWJ8WXLrcl1U22etX2TUrBH5ulc7gL8XVaIV-yWSxoK98AbejjcXLzLnrLWvfphAgPmi3nYg96nIagBroVB1HVNByM8LQ8_TA0a7rp8dYqbOQ4zvUpCEPc6SVQo3kcfnxVoNiGuwTrL754kUaAcYhsqyP17m8aO8yDkVbOQzF9dMZDwMRUU_LMMufYJcTMydIIqQBGfzZOyKPTy0AivTe0icT9QmBM_YY-DgZ6sdVKosT3EsTah8Jo9FXKUPxTlDw3Fzwd8WXg6CBDPyz78F9A-n329CLosa16sILlaenBuwwAE-ObLqTVGcfYdATlWDUDDFdtKIdk4Ip2r-LxdLWfix-qF9W2_qrVmqQqIMQz7govDWSaH5pW_nu-v20deAoY5j2HDrQuPtFnd9iUm1UhmHVNOfDTInDw2EqEJ23E_S0A5CY_mgxbiu4leskFsCVVdcqWTA8aRPlUn22tILpk-SQs-NRuwDzX1Z06nuLrCnfFGGXqeLJC2LSFOf82FTHXoUyNMEkKe_uMO3vvavVw-BHoUgMoLyf5ljR4aev69OkJsmSwBXG36o7Ulu8HT514y2gsn0jJW2HSPfLEgwl0Q6e4yM6AFEIR7o_1AMdI-qf2qCg0bQlQCHEfX6RfY' \
--header 'Cookie: TS0126f9dc=01b53461a60cbb3f4b604b6067dc0e494a06a620f7e7e7fef619c6d89a06a08065941af2f434a23c7687fde6280acf1128be33d60b' \
--data-raw '{
    "reference_id": "x-7986",
    "customer_type": "INDIVIDUAL",
    "given_name": "Cika Jerika",
    "surname": "Cijer",
    "nationality":"ID",
    "gender": "Female",
    "occupation":"OTHER",
    "address": {
        "country_code": "ID",
        "province_id": "31",
        "city_id": "3171",
        "line_1": "Jl. Senayan 1 No.15",
        "line_2": "Komplek BNI",
        "postal_code": "16320"
    },
    "date_of_birth": "11-01-1990",
    "place_of_birth": "Prabumulih",
    "identifications": [
        {
            "identification_type": "ktp",
            "identification_country": "ID",
            "identification_number": "1025456545454545"
        },
        {
            "identification_type": "npwp",
            "identification_country": "ID",
            "identification_number": "254545465425489"
        }
    ],
    "account_details": {
        "account_code": "BNI",
        "account_number": "123456789",
        "account_holder_name": "Cika Jerika"
    },
    "email": "cijer@email.com",
    "mobile": {
        "country_code": "62",
        "number": "08111555777"
    },
    "phone": {
        "country_code": "62",
        "number": "02199990000"
    },
    "fax": {
        "country_code": "62",
        "number": "02199991111"
    }
}'

Parameter	Description
reference_id required	`string` Your unique id for this customer. `Characters` Special and alphanumeric Maximum length 100 maximum characters
customer_type required	`string` Legal entity. Valid values: `INDIVIDUAL` or `BUSINESS`
given_name required	`string` Given name(s). Mandatory for `customer_type` is `INDIVIDUAL` and `BUSINESS`
surname required	`string` Surname or family name or last name. Only allowed if `customer_type` is `INDIVIDUAL`
nationality required	`string` Nationality country of the Customer. 2-letter ISO 3166-2 country code. Refer to code standard here
gender required	`string` Gender of the Customer. Only allowed `Male` or `Female` value
occupation required	`string` Occupation of the Customer. See Occupation Codes
address optional	`object` Customer's address
address.country_code required	`string` Customer’s country. 2-letter ISO 3166-2 country code. Refer to code standard here. If `customer_type` is `BUSINESS`, the country in which the corporate entity is registered. If `customer_type` is `INDIVIDUAL`, a country in which the customer holds nationality
address.province required	`string` Customer’s province. Download list here
address.city required	`string` Customer’s city. Download list here
address.district optional	`string` Customer’s district. Download list here
address.village optional	`string` Customer’s village. Download list here
address.post_code optional	`string` Customer’s postal code
address.line_1 optional	`string` First line of customer’s address. Typically used for building name and / or apartment number
address.line_2 optional	`string` Second line of customer’s address. Typically used for building name and / or apartment number
date_of_birth optional	`string` Date of Birth. Only allowed if `customer_type` is `INDIVIDUAL`. ISO 8601 format YYYY-MM-DD
place_of_birth optional	`string` Place of Birth. Only allowed if `customer_type` is `INDIVIDUAL`
date_of_registration optional	`string` Date of Registration. Only allowed if `customer_type` is `BUSINESS`. ISO 8601 format YYYY-MM-DD
identifications required	`object` A legal document that verifies the identity of the customer
identification.identification_type required	`string` Type of identity of the customer. Only allowed value `KTP`,`NPWP`,`SIM`,`PASSPORT`,`OTHER` `Characters` 10 characters
identification.identification_country required	`string` Country identity publisher of the customer. 2-letter ISO 3166-2 country code. Refer to code standard here. `Characters` 2 characters
identification.identification_number required	`string` Identification number of the customer. `Characters` 15 characters for `NPWP`, 16 characters for `KTP` and other identification type
account_details optional	`object` Customer’s bank account details
account_details.account_code optional	`string` The code of the account, can be bank codes (BCA, MANDIRI, etc.) or ewallet codes (GOPAY, OVO, etc.). Only Indonesian banks and ewallets supported currently. See Account Codes
account_details.account_number optional	`string` Destination bank account number. If disbursing to an e-wallet, phone number registered with the e-wallet account. `Characters` Numeric and hyphens `BCA required length` 10 characters `Other banks maximum length` No maximum characters `Other banks minimum length` 1 character `E-wallets` Phone number registered with the e-wallet(Example: 0812XXXXXX) * We support remittances to virtual accounts of major banks (BRI, BNI, Mandiri, CIMB Niaga, Permata, BTN, and NOBU Bank). * We support remittances to major e-wallets (GoPay, OVO, and Mandiri e-cash).
account_details.account_holder_name optional	`string` Name of account holder per the bank's or e-wallet's records `Characters` Special and alphanumeric `Maximum length` No maximum characters `Minimum length` 1 character
email optional	`string` Customer’s email address. Recommended if you want to notify the customer of the transaction statusShould include the top-level domain name Example: abc@email.com
mobile conditionally required	`object` Customer’s mobile number. Required for `Recipient` in `Cash Pick Up` transaction.
mobile.country_code conditionally required	`string` Customer’s mobile number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62. Required for `Recipient` in `Cash Pick Up` transaction.
mobile.number conditionally required	`string` Customer’s mobile number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX. Required for `Recipient` in `Cash Pick Up` transaction.
phone optional	`object` Customer’s phone number.
phone.country_code optional	`string` Customer’s phone number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62
phone.number optional	`string` Customer’s phone number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX
fax optional	`object` Customer’s fax number.
fax.country_code optional	`string` Customer’s fax number international country prefix. Recommended if you want to notify the customer of the transaction status 2-letter ISO 3166-2 country code. Refer to code standard here. Example: 62
fax.number optional	`string` Customer’s fax number without international prefix. Recommended if you want to notify the customer of the transaction status Example: 812XXXXXX

Update Customer Response

We return the updated customer object if the call succeeded.

Update Customer Errors

Update Customer Example Response:


{
    "data": {
        "id": "9564d7a6-f5d3-4dd4-911f-4d13144e8311",
        "reference_id": "x-89456",
        "customer_type": "INDIVIDUAL",
        "given_name": "Thomas Djorgi",
        "surname": "Thomdjor",
        "gender": "Female",
        "occupation": "OTHER",
        "fax": {
            "country_code": "62",
            "number": "02199991111"
        },
        "address": {
            "country_code": "ID",
            "province_id": "31",
            "city_id": "3171",
            "line_1": "Jl. Senayan 1 No.15",
            "line_2": "Komplek BNI",
            "postal_code": "16320"
        },
        "date_of_birth": "11-01-1990",
        "place_of_birth": "Prabumulih",
        "nationality": "ID",
        "identifications": [
            {
                "identification_type": "ktp",
                "identification_country": "ID",
                "identification_number": "1025456545454545"
            },
            {
                "identification_type": "npwp",
                "identification_country": "ID",
                "identification_number": "254545465425489"
            }
        ],
        "account_details": null,
        "email": "tomdjor@email.com",
        "mobile": {
            "country_code": "62",
            "number": "08111555777"
        },
        "phone": {
            "country_code": "62",
            "number": "02199990000"
        }
    }
}

Error Code	Description
API_VALIDATION_ERROR 400	Inputs are failing validation. The errors field contains details about which fields are violating validation No retry
INVALID_JSON_FORMAT 400	The request body is not a valid JSON format No retry
ACCOUNT_CODE_NOT_SUPPORTED_ERROR 400	The code of the account is currently not supported No retry
ACCOUNT_NUMBER_ERROR 400	Where account_code is “BCA”, account_number input needs to be 10 digits. Please check the account number length before retrying. No retry
DUPLICATE_CUSTOMER_ERROR 400	The external_id entered has been used before. Please enter a unique external_id and try again. No retry
CUSTOMER_NOT_FOUND_ERROR 400	Could not find customer. No retry

Get Customer With reference_id Request


GET https://dev-bankaccount.aricos.co.id/api/customers/__find-by?reference_id{reference_id}

Returns an array with a single object which contains the customer corresponding to the unique reference_id. Returns an empty array if there is no customer corresponding to the reference_id.

Get Customer With reference_id Example Request:


curl --location --request GET 'https://dev-bankaccount.aricos.co.id/api/customers/__find-by?reference_id=Bene429971273579-Cx-7986' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiJjNWMxNzVjMDAwOTE3ZjM3NmFlODQxN2YyNzExNzM0YzEyZTExYmIxOGNkNzBlYTMzZjRiMzM5MThmODQ5ZGIwMWMyNTA4ODI0NWEzN2M1NyIsImlhdCI6MTY0MjczMzE2Mi4yMTg2NTksIm5iZiI6MTY0MjczMzE2Mi4yMTg2NjcsImV4cCI6MTY3NDI2OTE2Mi4xOTA4NzUsInN1YiI6ImFlMzYwZjk2LWNkMjYtNGVlYy1hNzFlLTk1MTZkN2YzZjUwYSIsInNjb3BlcyI6W119.SSWzHI2hOKtWDzzwUCTqrZzs7uXK132BXmw5h_yDkIpAKQa91TdxdMTU-VhWMunmsQ8aAHRB2tlj-lyQk5P1XYXqeXCpajKgLHIL-P-r7PkXdHQmg8l8qamy_Vrz26zCtuSgD7YhqaTax7IxEXQL4mR9ixZnJ2wvUWz-lDIV0AbxxB5uQqspYcq-8kRjgMEr_wJvPcNW7gg9cPpznHIMcKP5XKpjjzvkn0LxKDkVB5mnAESpknchTdaMIeqFRQ_u3-kLuIm3Qp7Ri-4iiDY4I0N0MqGH93i-W-bOeF_MVI-CIa0AwLuBac-7gnsCVoxfi5QwJrs-pf1VbwsTTw6RSyxnFhp_DDiwC2pZFkoeyIu5hqPgq-u40wWsdHhCmXrurZJVntRDeMER_aC6nIo5WrMxSb_taqYLrzxuQ_ytht8N9ftkcIGt12xpp10jMcNzpECs5Of1Oc8cz5GudgkwOCpX98btstkVYjG-nu_QU0FI_Fxpv-XGGBJ6sbR9ZY96FRBLmjMfUEX7HPQ-HDo44TonabBvv0UhiEbTTYYman0F9PHWRctuc5Xi31m8fnWpOlRcr5dHKmOqxa2YTZgSzhMsZw2gAOXhmH49ef4TNm3ly2bbMHZqDcx6GwTa-rdIK2TZ4uXU9MwZ6fWliu3O5oKOYu2dcLQLBZyeN_BOPak'

Query Parameter	Description
reference_id optional	`string` Unique ID you provided in the Create Customer request The reference_id must match the reference_id used at customer creation precisely

Get Customer With reference_id Example Response:


{
    "data": {
        "id": "9560ea7c-a505-47a9-8482-c2063ba64ae7",
        "reference_id": "x-7986",
        "customer_type": "INDIVIDUAL",
        "given_name": "Cika Jerika",
        "surname": "Cijer",
        "gender": "Female",
        "occupation": "OTHER",
        "fax": {
            "number": "02199991111",
            "country_code": "62"
        },
        "address": {
            "country_code": "ID",
            "province_id": "31",
            "city_id": "3171",
            "line_1": "Jl. Senayan 1 No.15",
            "line_2": "Komplek BNI",
            "postal_code": "16320"
        },
        "date_of_birth": "1990-11-01",
        "place_of_birth": "Prabumulih",
        "nationality": "ID",
        "identifications": [
            {
                "identification_type": "ktp",
                "identification_number": "1025456545454545",
                "identification_country": "ID"
            },
            {
                "identification_type": "npwp",
                "identification_number": "254545465425489",
                "identification_country": "ID"
            }
        ],
        "account_details": {
            "id": "9560ea7c-ad42-4ef9-8d71-39a42f24d1c5",
            "account_code": "BNI",
            "account_number": "123456789",
            "account_holder_name": "Cika Jerika"
        },
        "email": "cijer@email.com",
        "mobile": {
            "country_code": "62",
            "number": "08111555777"
        },
        "phone": {
            "country_code": "62",
            "number": "02199990000"
        }
    }
}

Bank Account Remittance

Our Bank Account Remittance APIs allow you to send remittances from your Aricos Account on behalf of a sender to your designated recipient. Only IDR-IDR transfers supported currently.

Create Remittance


POST https://dev-bankaccount.aricos.co.id/api/remittances

Sends a new remittance from your Aricos Account to a recipient. You’ll need to have created a customer representing the sender and a customer representing the recipient first.

Your Aricos account balance must be able to cover the payout amount and the transaction fees, or you’ll receive an “Insufficient Balance” error.

Create Remittance Request

Create Remittance Example Request:


curl --location --request POST 'https://dev-bankaccount.aricos.co.id/api/remittances' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiJjNWMxNzVjMDAwOTE3ZjM3NmFlODQxN2YyNzExNzM0YzEyZTExYmIxOGNkNzBlYTMzZjRiMzM5MThmODQ5ZGIwMWMyNTA4ODI0NWEzN2M1NyIsImlhdCI6MTY0MjczMzE2Mi4yMTg2NTksIm5iZiI6MTY0MjczMzE2Mi4yMTg2NjcsImV4cCI6MTY3NDI2OTE2Mi4xOTA4NzUsInN1YiI6ImFlMzYwZjk2LWNkMjYtNGVlYy1hNzFlLTk1MTZkN2YzZjUwYSIsInNjb3BlcyI6W119.SSWzHI2hOKtWDzzwUCTqrZzs7uXK132BXmw5h_yDkIpAKQa91TdxdMTU-VhWMunmsQ8aAHRB2tlj-lyQk5P1XYXqeXCpajKgLHIL-P-r7PkXdHQmg8l8qamy_Vrz26zCtuSgD7YhqaTax7IxEXQL4mR9ixZnJ2wvUWz-lDIV0AbxxB5uQqspYcq-8kRjgMEr_wJvPcNW7gg9cPpznHIMcKP5XKpjjzvkn0LxKDkVB5mnAESpknchTdaMIeqFRQ_u3-kLuIm3Qp7Ri-4iiDY4I0N0MqGH93i-W-bOeF_MVI-CIa0AwLuBac-7gnsCVoxfi5QwJrs-pf1VbwsTTw6RSyxnFhp_DDiwC2pZFkoeyIu5hqPgq-u40wWsdHhCmXrurZJVntRDeMER_aC6nIo5WrMxSb_taqYLrzxuQ_ytht8N9ftkcIGt12xpp10jMcNzpECs5Of1Oc8cz5GudgkwOCpX98btstkVYjG-nu_QU0FI_Fxpv-XGGBJ6sbR9ZY96FRBLmjMfUEX7HPQ-HDo44TonabBvv0UhiEbTTYYman0F9PHWRctuc5Xi31m8fnWpOlRcr5dHKmOqxa2YTZgSzhMsZw2gAOXhmH49ef4TNm3ly2bbMHZqDcx6GwTa-rdIK2TZ4uXU9MwZ6fWliu3O5oKOYu2dcLQLBZyeN_BOPak' \
--data-raw '{
    "reference_id": "XXX-3344",
    "method": "A2A",
    "amount": 50000,
    "purpose_code": "FAMILY",
    "source_of_funds": "PERSONAL_SAVINGS",
    "description": "Transfer untuk ibu",
    "sender_customer_id": "9564d736-8852-4e4a-ad8a-0f40d14acb69",
    "recipient_customer_id": "9564d7a6-f5d3-4dd4-911f-4d13144e8311",
    "agent_id": "dcd08b39-f7af-445b-9643-c604de4a101d"
}'

Parameter	Description
external_id required	`string` A unique ID for your remittance. We validate this to protect against accidental duplicate remittances. `Characters` Special and alphanumeric `Maximum length` 100 characters
method required	`string` A fix value method flag for Bank Account Transaction. We validate this to make sure your remittance run in `Bank Account` transaction. Use Fix Value `A2A` always use the fix value when sending remittance request
amount required	`number` Transfer amount `Characters` Numerical integers, no decimals `Maximum limit (BCA, Mandiri, BRI, BNI, BNI Syariah, CIMB, CIMB_UUS, PERMATA)` No Limit* `Minimum limit (BCA, Mandiri, BRI, BNI, BNI Syariah, CIMB, CIMB_UUS, PERMATA)` No Limit `Maximum limit (Other banks)` Rp.50.000.000 `Minimum limit (Other banks)` Rp. 10.000 While there is theoretically no maximum transfer limit for transfers to these banks, please note that we may have to report all transaction amounts above Rp 100.000.000 to the financial authorities in Indonesia along with supporting documentation regarding the underlying transactions. *** Disbursements above Rp 50.000.000 to banks other than BCA, Mandiri, BNI, BNI Syariah, BRI, Permata will be processed between 8am-2pm (UTC+07:00) on bank working days. The disbursement can be expected to arrive by the next business day. (Processing times vary by financial institution and is subject to change.)
description required	`string` Description to send with the remittance. The recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf. `Maximum length` 512 characters
sender_customer_id required	`string` The id of the sender customer (as returned by Aricos’s Create Customer endpoint). The following fields are required in the sender customer object: `given_name`, `customer_type`, `country_code`
recipient_customer_id required	`string` The id of the recipient customer (as returned by Aricos's Create Customer endpoint). The following fields are required in the recipient customer object: `given_name`, `customer_type`, `country_code`, `account_code`, `account_number`, `account_holder_name`
source_of_funds required	`string` Source of funds. Refer to our list of Source of Funds Codes
purpose_code required	`string` Purpose of the remittance. Refer to our list of Purpose Codes
agent_id required	`string` The destination Bank ID of your remittance. Refer to our list of Bank Lists

Create Remittance Response

Create Remittance Example Response:


{
    "data": {
        "id": "956685f1-e12b-4085-ba72-5b66ab568eb9",
        "reference_id": "1638158760806-54",
        "method": "A2A",
        "amount": 90000,
        "purpose_code": "FAMILY",
        "source_of_funds": "PERSONAL_SAVINGS",
        "description": "Transfer ke kampung",
        "transaction_status": "PENDING_RISK_ASSESSMENT",
        "sender": {
            "id": "9560ea7c-a505-47a9-8482-c2063ba64ae7",
            "reference_id": "x-7986",
            "customer_type": "INDIVIDUAL",
            "given_name": "Cika Jerika",
            "surname": "Cijer",
            "gender": "Female",
            "occupation": "OTHER",
            "fax": {
                "number": "02199991111",
                "country_code": "62"
            },
            "address": {
                "country_code": "ID",
                "province_id": "31",
                "city_id": "3171",
                "line_1": "Jl. Senayan 1 No.15",
                "line_2": "Komplek BNI",
                "postal_code": "16320"
            },
            "date_of_birth": "1990-11-01",
            "place_of_birth": "Prabumulih",
            "nationality": "ID",
            "identifications": [
                {
                    "identification_type": "ktp",
                    "identification_number": "1025456545454545",
                    "identification_country": "ID"
                },
                {
                    "identification_type": "npwp",
                    "identification_number": "254545465425489",
                    "identification_country": "ID"
                }
            ],
            "account_details": {
                "id": "9560ea7c-ad42-4ef9-8d71-39a42f24d1c5",
                "account_code": "BNI",
                "account_number": "123456789",
                "account_holder_name": "Cika Jerika"
            },
            "email": "cijer@email.com",
            "mobile": {
                "country_code": "62",
                "number": "08111555777"
            },
            "phone": {
                "country_code": "62",
                "number": "02199990000"
            }
        },
        "recipient": {
            "id": "9560e576-28b1-4fe2-9c7c-fb75f5fe40a0",
            "reference_id": "x-7984",
            "customer_type": "INDIVIDUAL",
            "given_name": "Mamang Daya",
            "surname": "Mangday",
            "gender": "Male",
            "occupation": "PILOT",
            "fax": {
                "number": "02199991111",
                "country_code": "62"
            },
            "address": {
                "country_code": "ID",
                "province_id": "31",
                "city_id": "3171",
                "line_1": "Jl. Senayan 1 No.15",
                "line_2": "Komplek BNI",
                "postal_code": "16320"
            },
            "date_of_birth": "1990-11-01",
            "place_of_birth": "Prabumulih",
            "nationality": "ID",
            "identifications": [
                {
                    "identification_type": "ktp",
                    "identification_number": "1025456545454545",
                    "identification_country": "ID"
                },
                {
                    "identification_type": "npwp",
                    "identification_number": "254545465425489",
                    "identification_country": "ID"
                }
            ],
            "account_details": {
                "id": "9560e576-2efa-4e7a-8553-567bfdbaf3e8",
                "account_code": "BNI",
                "account_number": "00987654321",
                "account_holder_name": "Mamang Daya"
            },
            "email": "dewi@email.com",
            "mobile": {
                "country_code": "62",
                "number": "08111555777"
            },
            "phone": {
                "country_code": "62",
                "number": "02199990000"
            }
        }
    }
}

We return a response with additional fields described below if there were no initial errors with the remittance creation (request formatted incorrectly, invalid purpose code, insufficient funds, etc). The status of the remittance will be initially marked as PENDING_RISK_ASSESSMENT.

Parameter	Description
status	`string` Status of the remittance. Default is `PENDING_RISK_ASSESSMENT`: Request is being processed and assessed in the risk scoring system. See Remittance Statuses
created	`string` An ISO timestamp that tracks when the remittance was created
updated	`string` An ISO timestamp that tracks when the remittance was updated
id	`string` Unique remittance ID

Create Remittance Errors

Error Code	Description
API_VALIDATION_ERROR 400	Inputs are failing validation. The errors field contains details about which fields are violating validation. No retry
INVALID_JSON_FORMAT 400	The request body is not a valid JSON format. No retry
DUPLICATE_REMITTANCE_ERROR 400	External ID has been used before. Use a unique External ID and try again. No retry
RECIPIENT_AMOUNT_ERROR 400	The transfer amount requested is lower than the prescribed minimum for the recipient bank. Amend the transfer amount before retrying. No retry
MAXIMUM_TRANSFER_LIMIT_ERROR 400	The transfer amount requested is higher than the prescribed maximum for the recipient bank. Amend the transfer amount before retrying. No retry
SENDER_CUSTOMER_VALIDATION_ERROR 400	There are missing inputs for this customer which are required for the remittance. The errors field contains details about which fields are violating validation. No retry
RECIPIENT_CUSTOMER_VALIDATION_ERROR 400	There are missing inputs for this customer which are required for the remittance. The errors field contains details about which fields are violating validation. No retry
SENDER_CUSTOMER_NOT_FOUND_ERROR 400	Could not find customer. No retry
RECIPIENT_CUSTOMER_NOT_FOUND_ERROR 400	Could not find customer. No retry
SERVER_ERROR 500	Error connecting to our server. Please use Get remittance by external_id API to check whether the remittance has already been created. If you receive an empty array, the remittance has not been created; please retry the remittance request in 1-2 hours. No retry

Get Remittance With external_id Request


GET https://dev-bankaccount.aricos.co.id/api/remittances/{external_id}

Returns an array with a single object which contains the remittance corresponding to the unique external_id. Returns an empty array if there is no remittance corresponding to the external_id.

Get Customer With external_id Example Request:


curl --location --request GET 'https://dev-bankaccount.aricos.co.id/api/remittances/XXX-2233' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NGM5MjY0OS1hZTA2LTRmNmUtYjAzYi1iNWE0MzI3ZDBhNDgiLCJqdGkiOiJjNWMxNzVjMDAwOTE3ZjM3NmFlODQxN2YyNzExNzM0YzEyZTExYmIxOGNkNzBlYTMzZjRiMzM5MThmODQ5ZGIwMWMyNTA4ODI0NWEzN2M1NyIsImlhdCI6MTY0MjczMzE2Mi4yMTg2NTksIm5iZiI6MTY0MjczMzE2Mi4yMTg2NjcsImV4cCI6MTY3NDI2OTE2Mi4xOTA4NzUsInN1YiI6ImFlMzYwZjk2LWNkMjYtNGVlYy1hNzFlLTk1MTZkN2YzZjUwYSIsInNjb3BlcyI6W119.SSWzHI2hOKtWDzzwUCTqrZzs7uXK132BXmw5h_yDkIpAKQa91TdxdMTU-VhWMunmsQ8aAHRB2tlj-lyQk5P1XYXqeXCpajKgLHIL-P-r7PkXdHQmg8l8qamy_Vrz26zCtuSgD7YhqaTax7IxEXQL4mR9ixZnJ2wvUWz-lDIV0AbxxB5uQqspYcq-8kRjgMEr_wJvPcNW7gg9cPpznHIMcKP5XKpjjzvkn0LxKDkVB5mnAESpknchTdaMIeqFRQ_u3-kLuIm3Qp7Ri-4iiDY4I0N0MqGH93i-W-bOeF_MVI-CIa0AwLuBac-7gnsCVoxfi5QwJrs-pf1VbwsTTw6RSyxnFhp_DDiwC2pZFkoeyIu5hqPgq-u40wWsdHhCmXrurZJVntRDeMER_aC6nIo5WrMxSb_taqYLrzxuQ_ytht8N9ftkcIGt12xpp10jMcNzpECs5Of1Oc8cz5GudgkwOCpX98btstkVYjG-nu_QU0FI_Fxpv-XGGBJ6sbR9ZY96FRBLmjMfUEX7HPQ-HDo44TonabBvv0UhiEbTTYYman0F9PHWRctuc5Xi31m8fnWpOlRcr5dHKmOqxa2YTZgSzhMsZw2gAOXhmH49ef4TNm3ly2bbMHZqDcx6GwTa-rdIK2TZ4uXU9MwZ6fWliu3O5oKOYu2dcLQLBZyeN_BOPak'

Get Remittance With external_id Example Response:


{
    "status": "PENDING_RISK_ASSESSMENT",
    "external_id": "XXX10",
    "amount": 300000,
    "purpose_code": "FAMILY",
    "source_of_funds": "PERSONAL_SAVINGS",
    "description": "Transfer ke kampung via Bank Account",
    "sender_customer_id": "de7ae696-f7b8-4576-ac41ad8bdf680704",
    "recipient_customer_id": "a6f19ba7-cc86-4747-a9de125eebbb074f",
    "created": "2022-01-06T15:16:51.505Z",
    "updated": "2022-01-06T15:16:51.505Z",
    "id": "61d707e3914969153a346ca3"
}

Parameter	Description
external_id required	`string` Unique ID you provided in the Create Remittance request The external_id must match the external_id used at remittance creation precisely

Data References

Below are some list of data references that you require to use our API's.

Agent Codes

ID	Key	Description
37c184a7-0fb8-4a06-b087-49f17163e863	BCA	Bank Central Asia
0e765d93-9723-4ec8-98c1-23003143ef9a	BCA_SYR	Bank Central Asia Syariah
ca0295c6-6be7-4609-9606-c1bb25f7847e	BJB	Bank BJB
dcd08b39-f7af-445b-9643-c604de4a101d	BNI	Bank Negara Indonesia
4f672043-2b01-4fe0-a1f6-ad13962e48b7	BNI_SYR	BNI Syariah
0766f37c-ae8d-4d86-ae06-e4b1ce236fd1	BRI	Bank Rakyat Indonesia
686c0948-4338-44b6-90e2-364dc44f35ae	BRI_SYR	BRI Syariah
a225789f-d5c3-4e62-ad59-8599d2df5d0a	CENTRATAMA	Centratama Nasional Bank
e8f04b8b-244a-4a92-8175-0b8b5b40c3d0	CIMB	Bank CIMB Niaga
497fac65-ffe5-4931-bc69-fb56f2c9fe1a	DANAMON	Bank Danamon
8863cd7c-719a-4a02-9766-a488c844aad4	MANDIRI	Bank Mandiri
427c76de-0e9b-47fb-8200-c62390c5598a	MANDIRI_SYR	Bank Mandiri Syariah
3d46860d-8d96-4982-bb77-dc5e74ddd3d2	RIAU_DAN_KEPRI	BPD Riau Dan Kepri
4ec745a2-ab71-47d3-a67b-c3c5cadfa151	ROYAL	Bank Royal Indonesia
286aa3e5-c747-41dd-965e-4df5ac792009	SINARMAS_UUS	Bank Sinarmas UUS
b28a6020-5715-4fb0-8162-c8dba00dba1f	SUMUT	BPD Sumut
1168cf9b-a361-4ce8-b0c5-707d4d0e0f75	TABUNGAN_PENSIUNAN_NASIONAL	Bank Tabungan Pensiunan Nasional
7dbc1f29-0bf6-47af-b085-04b4898f7b40	ACEH	BPD Aceh
1faa0310-d168-46b1-8a20-ed23d1106b7b	ACEH_UUS	BPD Aceh UUS
e8259b9c-1c48-4790-87d5-b4177c7fef2c	AGRIS	Bank Agris
2c5186f3-f3dc-4403-8b7c-633615c02d96	AGRONIAGA	Bank BRI Agroniaga
1dc8787c-8ccb-4238-ba8d-b944fc82466c	AMAR	Bank Amar Indonesia (formerly Anglomas International Bank)
d7a3c514-122b-453f-84d7-a655a03973c5	ANZ	Bank ANZ Indonesia
a5c7ed6a-3e9a-4ded-b468-311aa2f68e09	ARTA_NIAGA_KENCANA	Bank Arta Niaga Kencana
ed1492dc-2246-439b-92f5-05ce10d607a1	ARTHA	Bank Artha Graha International
a37bd8bd-5cab-48c9-a3ec-7620980fc0a3	ARTOS	Bank Artos Indonesia
cfdd6374-e9b4-45cb-a5da-7b69b67042de	BALI	BPD Bali
27dd6012-99a0-410e-b390-58e5ac5d0852	BAML	Bank of America Merill-Lynch
e53972b7-3805-4739-a10f-1353c3ea3541	BANGKOK	Bangkok Bank
f47428df-93d1-4e22-b20d-5027e9487f5f	BANTEN	BPD Banten (formerly Bank Pundi Indonesia)
770cda3d-28dc-4c5c-9278-07f7363a847a	BCA_DIGITAL	Bank Central Asia Digital (BluBCA)
259a5418-c3ec-4fd3-8e8b-54c83a27e87c	BENGKULU	BPD Bengkulu
707e77c9-8360-4a08-abde-e8e9ec57b63b	BISNIS_INTERNASIONAL	Bank Bisnis Internasional
efb98175-f10d-4224-a95d-1660db2535f8	BJB_SYR	Bank BJB Syariah
eb6e2cbe-1b5e-4c46-aeb4-10528b429ed0	BNP_PARIBAS	Bank BNP Paribas
d517c60b-975a-4b3c-bf02-e0e37dff1c5a	BOC	Bank of China (BOC)
ab5462b4-20ef-4390-9d18-7d9e357a1528	BSI	Bank Syariah Indonesia (BSI)
164d2066-6326-4bdb-b545-5530a59d854e	BTN	Bank Tabungan Negara (BTN)
1819473a-db73-4296-a470-bf5a3bbeb244	BTN_UUS	Bank Tabungan Negara (BTN) UUS
2be61dc1-41c3-4947-b820-ec706de4be0a	BTPN_SYARIAH	BTPN Syariah (formerly Bank Sahabat Purba Danarta and Bank Tabungan Pensiunan Nasional UUS)
a1269069-1f69-498f-99c0-917fc6a9ca26	BUKOPIN	Bank Bukopin
12135f0d-bda3-4e72-80ae-dc9eabd95c56	BUKOPIN_SYR	Bank Syariah Bukopin
f9eaa3b0-9411-4adf-84ed-997a2b0753d1	BUMI_ARTA	Bank Bumi Arta
0dd9909c-7549-4f7d-a65e-2237cdbd03c2	CAPITAL	Bank Capital Indonesia
48eba4c8-d0b6-4067-8fc4-302f5f60bdf9	CCB	China Construction Bank Indonesia (formerly Bank Antar Daerah and Bank Windu Kentjana Int)
b1464ebb-db6b-4ffb-be58-b8035de76a97	CHINATRUST	Bank Chinatrust Indonesia
d930a8da-9ca3-4264-8af0-aa0adae50dfa	CIMB_UUS	Bank CIMB Niaga UUS
a39fdee9-8b51-48f1-9505-7463e34e3b69	CITIBANK	Citibank
3c15a710-62d4-4df3-81e8-e4d660af8d23	COMMONWEALTH	Bank Commonwealth
560fc226-0266-4d2c-9537-415a7191ad95	DAERAH_ISTIMEWA	BPD Daerah Istimewa Yogyakarta (DIY)
74940969-9838-46fb-87f1-348996e94047	DAERAH_ISTIMEWA_UUS	BPD Daerah Istimewa Yogyakarta (DIY) UUS
ecf31864-5fd6-47ac-a6f4-1fe5a9810fdb	DANAMON_UUS	Bank Danamon UUS
62e6a266-3aaf-4e96-bf34-6de8faeb3dbd	DBS	Bank DBS Indonesia
d46a5ba1-99d1-4c68-a53f-bb0c6d522ac3	DEUTSCHE	Deutsche Bank
1909f88f-9751-4396-a41c-8373ddf78d59	DINAR_INDONESIA	Bank Dinar Indonesia
1bc83028-86e1-4a54-84d0-c092ad25d043	DKI	Bank DKI
7a43da85-cee4-4de2-be74-83e8fbcb8a6d	DKI_UUS	Bank DKI UUS
1692293e-b6d8-4a74-860b-09d4653b1e9b	EXIMBANK	Indonesia Eximbank (formerly Bank Ekspor Indonesia)
e2efe4c7-b149-4158-9794-a33d595df1aa	FAMA	Bank Fama International
a90908ca-08bc-45a9-b6be-22d832a3a203	GANESHA	Bank Ganesha
72e56a7d-9fe0-425a-b5c0-9c836350dbbb	GOPAY	GoPay
7aa069e2-1345-4e8b-917e-1743841b4aa8	HANA	Bank Hana
baa92a9b-680e-4398-afcf-3b9eea03848a	HARDA_INTERNASIONAL	Bank Harda Internasional
1f08d58e-01c4-402a-88d0-451e238eb29b	HSBC	Hongkong and Shanghai Bank Corporation (HSBC) (formerly Bank Ekonomi Raharja)
35eb92ec-4416-42d1-8c6f-f6962c3b60ee	ICBC	Bank ICBC Indonesia
51a3cde1-966c-47df-94b6-3073eabad300	INA_PERDANA	Bank Ina Perdania
8ab225ce-fc13-47f6-b64c-30984f232c11	INDEX_SELINDO	Bank Index Selindo
ecb4542f-0d17-4e3a-b5ad-d7a9132e9edf	INDIA	Bank of India Indonesia
ba55253b-3bc3-4785-874c-f5deeeab7fba	JAMBI	BPD Jambi
c012a45a-c642-4a7d-baac-13cc4e38d9af	JAMBI_UUS	BPD Jambi UUS
93d356a1-b2c9-44bd-b2f4-844abc433724	JASA_JAKARTA	Bank Jasa Jakarta
33378408-6284-4fce-834c-9721de3cc1bf	JAWA_TENGAH	BPD Jawa Tengah
6caa08a0-d6f8-42bd-b701-1275ca9106f1	JAWA_TENGAH_UUS	BPD Jawa Tengah UUS
a6ef5610-d6b9-41e7-aaa3-0a8a86992d3d	JAWA_TIMUR	BPD Jawa Timur
b1b499b4-d90c-4a17-9c31-fc317342ddc2	JAWA_TIMUR_UUS	BPD Jawa Timur UUS
c88314be-62e4-4ea3-bffb-20d11bbec5ee	JPMORGAN	JP Morgan Chase Bank
f20da36c-225d-4362-8445-36f671e8dc5f	JTRUST	Bank JTrust Indonesia (formerly Bank Mutiara)
3f5a9be6-4414-437a-927a-423fdcf84e64	KALIMANTAN_BARAT	BPD Kalimantan Barat
2b0921bb-f99d-42be-bf0c-90d6aa1b933c	KALIMANTAN_BARAT_UUS	BPD Kalimantan Barat UUS
495bfad5-88be-4d0a-b1fc-52b410733678	KALIMANTAN_SELATAN	BPD Kalimantan Selatan
0929a540-1e41-40c6-824b-0b36adf43ea8	KALIMANTAN_SELATAN_UUS	BPD Kalimantan Selatan UUS
83a0e1a5-510a-4f38-8f6a-9390bed7880e	KALIMANTAN_TENGAH	BPD Kalimantan Tengah
c8f30047-e3b9-433d-9be6-20de2636f5a8	KALIMANTAN_TIMUR	BPD Kalimantan Timur
d2cec9f3-092d-4eb2-8815-86238cd947c6	KALIMANTAN_TIMUR_UUS	BPD Kalimantan Timur UUS
c1ade29c-e09c-45aa-bfd7-28b3045be6e8	KESEJAHTERAAN_EKONOMI	Bank Kesejahteraan Ekonomi
b5dbfe03-835f-4a04-9aab-08a492e550ce	LAMPUNG	BPD Lampung
04df76a7-b7f1-4f96-945a-9a46166255d9	MALUKU	BPD Maluku
cc995e02-b96b-4472-9f0d-959ab03b0645	MANDIRI_ECASH	Mandiri E-Cash
be77ec02-f995-4103-88c8-2e861f9ebf66	MANDIRI_TASPEN	Mandiri Taspen Pos (formerly Bank Sinar Harapan Bali)
fa34365e-3b26-4c78-bea2-31d7452c3c04	MASPION	Bank Maspion Indonesia
ea74ddf4-71d1-4326-bbf6-b5405f9db18b	MAYAPADA	Bank Mayapada International
a6180c69-c22c-4d7d-aab8-a68b94ed0794	MAYBANK	Bank Maybank (formerly BII)
4496121c-0665-4831-8d5d-69032127f1db	MAYBANK_SYR	Bank Maybank Syariah Indonesia
df3ec0ca-3e9c-4e1c-898c-6006c4f2aa05	MAYORA	Bank Mayora
e36f5a2e-a6db-437f-98f0-a4c4e47e597b	MEGA	Bank Mega
e3c8f715-1b98-4d4c-af92-1a6fee743535	MEGA_SYR	Bank Syariah Mega
e6c54ce8-51b1-46ee-b059-52fa7812b89f	MESTIKA_DHARMA	Bank Mestika Dharma
7795b270-9144-4510-8f03-f3cc7f498140	MITRA_NIAGA	Bank Mitra Niaga
6f338e2f-5abc-4b1f-a03d-529183acae6e	MITSUI	Bank Sumitomo Mitsui Indonesia
ed0318a9-b4b7-48d8-982f-823dda080d1a	MIZUHO	Bank Mizuho Indonesia
420315a6-72de-4498-90b3-f1eb2111ccf0	MNC_INTERNASIONAL	Bank MNC Internasional
76efc335-78fc-4d79-b5bc-90608696c324	MUAMALAT	Bank Muamalat Indonesia
2071fbd2-a3d2-4209-903d-4509f9ab7ad9	MULTI_ARTA_SENTOSA	Bank Multi Arta Sentosa
e40c197e-06dc-4a78-9d37-f6f06ea7a916	NATIONALNOBU	Bank Nationalnobu
072c24a9-86b8-429a-868b-812df568b383	NUSA_TENGGARA_BARAT	BPD Nusa Tenggara Barat
9b800a68-48e6-4a2b-81c8-779ccd587786	NUSA_TENGGARA_BARAT_UUS	BPD Nusa Tenggara Barat UUS
89f5b93c-61c2-4b20-99ea-29eb730457d0	NUSA_TENGGARA_TIMUR	BPD Nusa Tenggara Timur
8adbcc79-be0d-463a-8c76-1c06f4a7c276	NUSANTARA_PARAHYANGAN	Bank Nusantara Parahyangan
db02929c-8b6c-4869-9bdf-b180c8b80519	OCBC	Bank OCBC NISP
65554d34-c6c6-490c-bed0-4b952509c4de	OCBC_UUS	Bank OCBC NISP UUS
22f14a7f-9ad7-4662-9490-f24864f29331	OKE	Bank Oke Indonesia (formerly Bank Andara)
8e9760bb-cd33-4c09-8022-4b167b692929	OVO	OVO
63eb6757-8132-4857-a0b7-6408552a384d	PANIN	Bank Panin
a2849ab2-ae5b-429c-9953-1aed6672f88e	PANIN_SYR	Bank Panin Syariah
486b6b0a-bacf-4f51-be65-a71374a31c0b	PAPUA	BPD Papua
cf66bddf-e95a-429d-9e8c-fc2b22cd4e8e	PERMATA	Bank Permata
bf036c1f-cd91-4469-8cb2-d5eccbc26841	PERMATA_UUS	Bank Permata UUS
b27d52f6-5ccc-4faf-bcd7-e94b584bc6ab	PRIMA_MASTER	Prima Master Bank
2d8f8438-5330-4744-ba95-eb84b81ffdc6	QNB_INDONESIA	Bank QNB Indonesia (formerly Bank QNB Kesawan)
b06ccdc7-cdd7-4e1f-8af4-d73bb63f240b	RABOBANK	Bank Rabobank International Indonesia
97273366-2680-4490-962f-a488aa3a5270	RBS	Royal Bank of Scotland (RBS)
44428fad-f06e-48c5-bae4-a5a35a8cca62	RESONA	Bank Resona Perdania
2334a8e4-ed4a-4dd1-af84-dc32e41587c6	RIAU_DAN_KEPRI_UUS	BPD Riau Dan Kepri UUS
c258ff97-cc58-45e4-b279-b76ea5538389	SAHABAT_SAMPOERNA	Bank Sahabat Sampoerna
580dffdb-a48a-4818-bcd4-1fbe9541a5f7	SBI_INDONESIA	Bank SBI Indonesia
a9873043-790a-46bb-834d-88a9883b744d	SHINHAN	Bank Shinhan Indonesia (formerly Bank Metro Express)
24edb279-6c03-4bfa-a473-3f21b0df90f0	SINARMAS	Sinarmas
c37bac90-7359-48eb-8bfa-ead08fb2fe65	STANDARD_CHARTERED	Standard Chartered Bank
23124c7d-8db6-4188-b054-2e4467bb8a61	SULAWESI	BPD Sulawesi Tengah
116f1eea-866c-4f97-8fe5-10712b68a9fd	SULAWESI_TENGGARA	BPD Sulawesi Tenggara
22bdacdc-b5a1-40a7-9d7f-b9df5bbcf1e3	SULSELBAR	BPD Sulselbar
28e4d780-c558-4fcc-b9ae-89ab39203d34	SULSELBAR_UUS	BPD Sulselbar UUS
18ed5d88-f209-4846-a8f7-e42b722cd6a1	SULUT	BPD Sulut
0fd53a54-0978-421c-85b4-f50d000611a4	SUMATERA_BARAT	BPD Sumatera Barat
2b65358c-c2de-457c-89ea-21c02a05054a	SUMATERA_BARAT_UUS	BPD Sumatera Barat UUS
80cfe001-2953-4ced-bd80-a4400462442b	SUMSEL_DAN_BABEL	BPD Sumsel Dan Babel
cc5b8df1-87f5-4d39-af98-9edccc982191	SUMSEL_DAN_BABEL_UUS	BPD Sumsel Dan Babel UUS
f4a98ac2-edf9-45cc-8edf-31bce2b80325	SUMUT_UUS	BPD Sumut UUS
6a118182-2586-4381-b9f6-9e115b1b96c4	TOKYO	Bank of Tokyo Mitsubishi UFJ
101df8a8-c12b-437e-834a-ead18f3bcafb	UOB	Bank UOB Indonesia
d97e5e39-c4de-4562-a000-6e56229ee7b4	VICTORIA_INTERNASIONAL	Bank Victoria Internasional
faf5a7a9-6ade-4ec7-9e76-ab6489bff1a1	VICTORIA_SYR	Bank Victoria Syariah
1cbd6abe-e4b2-46c0-801e-1302a90e3133	WOORI	Bank Woori Saudara Indonesia (formerly Bank Himpunan Saudara and Bank Woori Indonesia)
63d88c05-3141-46dd-81f3-572a00f18ff2	YUDHA_BHAKTI	Bank Yudha Bhakti

Purpose Codes

Key	Description
SELF	Transfer to own account
FAMILY	Family Maintenance
EDUCATION	Education-related student expenses
MEDICAL	Medical Treatment
HOTEL	Hotel Accomodation
TRAVEL	Travel
UTILITIES	Utility Bills
LOAN_REPAYMENT	Repayment of Loans
TAX_PAYMENT	Tax Payment
RESIDENCE_PURCHASE	Purchase of Residential Property
RESIDENCE_RENT	Payment of Property Rental
INSURANCE	Insurance
MUTUAL_FUND	Mutual Fund Investment
SHARES_INVESTMENT	Investment in Shares
DONATIONS	Donations
ADVERTISING	Advertising & Public relations-related expenses
ROYALTY_FEES	Royalty fees, trademark fees, patent fees, and copyright fees
BROKER_FEES	Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee
ADVISORS	Fees for advisors, technical assistance, and academic purpose, including remuneration for specialists
OFFICE	Representative office expenses
CONSTRUCTION	Construction costs / expenses
SHIPMENT	Transportation fees for goods
EXPORT	For payment of exported goods
DELIVERY	Delivery fees for goods
TRADES	General Goods Trades - Offline trade
SALARY	Salary
REFUND	Refund
LOAN	Loan

Source of Funds

Key	Description
INVESTMENT	Bonds, fixed deposits, preference shares, business ownership/equity or property ownership
PERSONAL_SAVINGS	Funds kept in an account in a bank or a similar organization
BUSINESS_REVENUE	Income from a business or a company
LEGACY	Inherited money from a will
BUSINESS_ARRANGEMENT	Any understanding, procedure, course of dealing, or arrangement between a creditor and a seller
LOAN	A sum of money that is borrowed
SALARY	A fixed regular payment made by an employer
OTHER	Other

Identification Codes

Key	Description
KTP	Kartu Tanda Penduduk (national identity card number) of the customer
NPWP	Nomor Pokok Wajib Pajak (tax number) of the customer
SIM	Surat Izin Mengemudi (driver’s licence) of the customer
PASSPORT	Passport of the customer
OTHER	Other identification type of the customer

Occupation Codes

Key	Desc
OTHERS	OTHERS
STUDENT	STUDENT
HOUSEWIFE	HOUSEWIFE
ENTERPRENEUR	ENTERPRENEUR
PRIVATE_EMPLOYEES	PRIVATE EMPLOYEES
STATE_EMPLOYEES	STATE EMPLOYEES
ARMY	ARMY
POLICE	POLICE
LECTURER	LECTURER
TEACHER	TEACHER
DOCTOR	DOCTOR
MIDWIFE	MIDWIFE
NURSE	NURSE
MEMBER_OF_HOUSE_REPRESENTATIVE	MEMBER OF HOUSE REPRESENTATIVE
FARMER	FARMER
BREEEDER	BREEEDER
FISHERMAN	FISHERMAN
HOUSEMAID	HOUSEMAID
LABOR	LABOR
DRIVER	DRIVER
TRADER	TRADER
FARM_WORKERS	FARM WORKERS
STOCKMAN	STOCKMAN
BARBER	BARBER
ELECTRICIAN	ELECTRICIAN
STONEMASON	STONEMASON
CARPENTER	CARPENTER
COBBLER	COBBLER
BLACKSMITH	BLACKSMITH
TAILOR	TAILOR
MECHANIC	MECHANIC
DENTIST	DENTIST
ARTIST	ARTIST
TRADITIONAL_HEALER	TRADITIONAL HEALER
TRADITIONA_MIDWIFE	TRADITIONA MIDWIFE
HAIRDRESSER	HAIRDRESSER
MAKEUP_ARTIST	MAKEUP ARTIST
FASHION_DESIGNER	FASHION DESIGNER
FASHION_DESIGNER	FASHION DESIGNER
JOURNALIST	JOURNALIST
CHEF	CHEF
PROMOTOR	PROMOTOR
TRANSLATOR	TRANSLATOR
RELIGIOUS_LEADER	RELIGIOUS LEADER
PENSIONARY	PENSIONARY
CONSTRUCTION	CONSTRUCTION
TRANSPORTATION	TRANSPORTATION
AMBASSADOR	AMBASSADOR
PILOT	PILOT
LAWYER	LAWYER
NOTARY_PUBLIC	NOTARY PUBLIC
ARCHITECT	ARCHITECT
ACCOUNTANT	ACCOUNTANT
CONSULTANT	CONSULTANT
PHARMACIST	PHARMACIST
PSYCHIATRIST	PSYCHIATRIST
TV_ANNOUNCER	TV ANNOUNCER
RADIO_ANNOUNCER	RADIO ANNOUNCER
SAILOR	SAILOR
RESEARCHER	RESEARCHER
BROKER	BROKER

Remittance Statuses

Key	Description
PENDING_RISK_ASSESSMENT	Request is being processed and assessed in the risk scoring system.
COMPLIANCE_VERIFICATION	Request is considered medium or high risk, and is being reviewed by our compliance team. Our team will contact you via email for extra information for enhanced due diligence.
COMPLIANCE_REJECTED	Request is rejected by compliance.
PROCESSING	Request has been approved and the remittance is queued to be transferred to the recipient.
COMPLETED	The sending bank has confirmed transmission of the remittance.
FAILED	Remittance could not be transferred to the recipient due to certain errors. See Remittances Failure Codes.

Remittance Failure Codes

Key	Description
INSUFFICIENT_BALANCE	The balance in your account is insufficient to make the remittance in the desired amount.
UNKNOWN_BANK_NETWORK_ERROR	The bank networks have returned an unknown error to us. We are unable to predict whether the remittance will succeed should you retry the same remittance request.
TEMPORARY_BANK_NETWORK_ERROR	The bank networks are experiencing a temporary error. Please retry the remittance in 1-3 hours.
TEMPORARY_TRANSFER_ERROR	We’ve encountered a temporary issue while processing this remittance. Please retry the remittance in 1-2 hours.
SWITCHING_NETWORK_ERROR	At least one of the switching networks is encountering an issue. Please retry the remittance in 1-3 hours.
INVALID_DESTINATION	The banks have reported that the destination account is unregistered or blocked. If unsure about this, please retry again or contact the destination bank directly regarding the status of the destination account.
TRANSFER_ERROR	We’ve encountered a fatal error while processing this remittance. Certain API fields in your request may be invalid. Please contact our customer support team for more information.

Errors

Below are some of most common errors across all our endpoints. Specific errors are located under each endpoint. If you have any questions please contact us.

Error Code	Meaning
400	Bad request, e.g. validation error
401	Unauthorised access, e.g. the wrong user or password
403	Forbidden access, e.g. account does not have permission for this endpoint
404	Page or data not found
500	Unhandled error - contact us when this happens. If this was a response to a request to send money, please check the status of the resource before retrying to ensure that the request will not be processed twice.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Introduction

Bank Account Remittance Overview

Getting Started

Set Up Your Account

Retrieve Your API Account

Start Testing!

Postman Collection

Account

Account Register

Account Login

Login Request

Login Response

Balance

Prefund Your Balance

Get Balance

Get Balance Request

Get Balance Response

Customers

Customer Data

Create Customer Request

Create Customer Response

Create Customer Errors

Update Customer Request

Update Customer Response

Update Customer Errors

Get Customer With reference_id Request

Bank Account Remittance

Create Remittance

Create Remittance Request

Create Remittance Response

Create Remittance Errors

Get Remittance With external_id Request

Data References

Agent Codes

Purpose Codes

Source of Funds

Identification Codes

Occupation Codes

Remittance Statuses

Remittance Failure Codes

Errors