Getting started

Endpoints

The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH, and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.

Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one.

Requests

Requests must be sent over HTTPS with any payload formatted in JSON. Depending on if a request is authenticated with the new API Tokens or the old API Keys, required headers differ and are detailed below.

Authorization

Authorization provide a new way to authenticate with the Account Verify API. They allow for scoped and permissioned access to resources and use the RFC compliant Authorization Bearer Token Header.

Name	Format	Description
Authorization	Bearer {token}	You ask, we give.

Rate Limiting

60 times per minute

Transfer

Properties

Name	Format	Description
status	Enumerate (initialized\| processing \| success \| failed)	business license code
brid	String \| Numbers and letters only	business license code
session	String \| Numbers and letters only \| unique	a session identifier
verify_amount	Double \| between 0.01 and 9.99	Verify Amount

Properties - status

Result	Description
initialized	Means just message us a transfer will be begin and user have not fill the bank info form.
processing	Means user have filled the bank info form correctly.
success	Means transfer job in bank success
failed	Means transfer are failed due to some issue like: 1. Correct SESSION but wrong BRID 2. Correct SESSION and BRID but wrong COMPANY_NAME 3. Incorrect bank identification number cause the transfer job failed 4. Unavailable bank account 5. Other unpredictable reason

Properties - failed_code

value	Description
1	Correct SESSION but wrong BRID
2	Correct SESSION and BRID but wrong COMPANY_NAME
3	Incorrect bank identification number cause the transfer job failed
4	Unavailable bank account
99	Unknow Error, and we will record some remark at this transfer

Basic Exception

Request with illegal params


xxxxxxxxxx
{
    "message": "The given data was invalid.",
    "errors": {
        "brid": [
            "The brid field is required."
        ],
        "session": [
            "The session field is required."
        ]
    },
    "status_code": 422
}

Request too fast


xxxxxxxxxx
{
    "message": "You have exceeded your rate limit.",
    "status_code": 429
}

Start a transfer

curl


xxxxxxxxxx
curl --location --request POST '{Endpoints}/api/transfers' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "brid":"91350104335729821P",
    "session":"489201",
    "verify_amount": 0.32
}'

Response


xxxxxxxxxx
{
    "message": "success",
    "code": 200,
    "data": {
        "brid": "91350104335729821P",
        "session": "489201",
        "verify_amount": 0.32,
        "status": "initialized",
        "updated_at": "2021-01-28T01:18:42.000000Z",
        "created_at": "2021-01-28T01:18:42.000000Z",
        "id": 1
    }
}

Response with a failed transfer


xxxxxxxxxx
{
    "message": "success",
    "code": 200,
    "failed_code": 1,
    "remark": "",
    "data": {
        "id": 5,
        "created_at": "2021-01-28T03:25:55.000000Z",
        "updated_at": "2021-02-03T03:36:53.000000Z",
        "session": "DcwMjFiZDIyYzQzNzU3MzZiOWI0OWNmNGY1ODUwYzQxOTIwY2YxYzZiMjdj",
        "brid": "91350104335729821P",
        "status": "failed"
    }
}

Exception

Submit a transfer without a unique session


xxxxxxxxxx
{
    "message": "The given data was invalid.",
    "errors": {
        "session": [
            "The session has already been taken."
        ]
    },
    "status_code": 422
}

Submit a transfer without a illegal verify mount


xxxxxxxxxx
{
    "message": "The given data was invalid.",
    "errors": {
        "verify_amount": [
            "The verify amount must be between 0.01 and 9.99."
        ]
    },
    "status_code": 422
}

Get transfer progress

curl


xxxxxxxxxx
curl --location --request GET '{Endpoints}/api/transfers?session=489201&brid=91350104335729821P' \
--header 'Authorization: Bearer {token}'

Response


xxxxxxxxxx
{
    "message": "success",
    "code": 200,
    "data": {
        "id": 2,
        "created_at": "2021-01-28T01:12:29.000000Z",
        "updated_at": "2021-01-28T01:12:29.000000Z",
        "session": "489201",
        "brid": "91350104335729821P",
        "verify_amount": 0.32,
        "status": "initialized",
    }
}

Exception

Get transfer by unknow session id or brid


xxxxxxxxxx
{
    "message": "unknow transfer record",
    "status_code": 422
}