Get StartedAccount and Balance ManagementPaymentsPayoutsAPI References

Inquiry Account

This API is used to inquiry Payout beneficiary account information

POST [BASE_URL]/v1/inquiry-account

Request

Request Body

{
  "channelCode": "string",
  "channelInformation": {
    "accountNumber": "string",
    "accountName": "string"
  }
}

Detail Parameter Request

Parameter

Data Type

Requirement

Description

channelCode

String

M

Channel code for payout destination such as Bank, E wallet or other channels

List of Channel code can be accessed here

Channel Code

channelInformation

Object

M

  • accountNumber

String

M

Account Number of payout destination

  • accountName

String

M

Account Name of payout destination from Merchant

Response

Response Body

{
  "code": "string",
  "message": "string",
  "data": {
    "uuid": "string",
    "merchantId": "string",
    "inquiryResult": {
      "status": "string",
      "detail": "string",
    }
  }
}

Detail Parameter Response

Parameter

Data Type

Requirement

Description

code

String

M

Response code

message

String

M

Response description

data

Object

M

  • uuid

String

M

Unique Inquiry Account ID

  • merchantId

String

M

Unique merchant ID

  • inquiryResult

Object

O

>> Status

String

M

Inquiry status to indicate the result

Potential value

  • VALID = requested account matched

  • WARNING = requested account is available, but the account might be mismatched. Please check detail for more information

  • INVALID = requested account is invalid or can’t be found

  • PENDING = inquiry account is still in progress

>> detail

String

C

Only available if the status is WARNING, INVALID, and PENDING explains the reason below:

Warning:

  • Account Name is not similar = "The account name entered does not match the bank's records. Please check the account information and try again. Bank record:{accountName from bank}"

  • Account Name is similar = “The account name entered is not an exact match. Please check the account information and try again. Bank record: {accountName from bank}”

Invalid:

Account number not found.

Pending:

Inquiry in progress

Tips! Storing Inquiry ID for future usage

After you have successfully received a response from the Inquiry Account, you can store the inquiryId.

So whenever you want to create a Payout to the same Beneficiary Account, you don't need to hit Inquiry Account API again just pass inquiryId on the payload here

List of Response Codes

Response Code

Response Message

Error Object

00

Success

-

credentials_invalid

Access Token is Invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Request new access token"
      }
    ],
    "traceId": "{trace id}" 
  }
}

field_format_invalid

Format Field is Invalid

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} format is correct"
      }
    ],
    "traceId": "{trace id}" 
  }
}

field_required

Mandatory Field is Missing

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure {field name} value is fulfilled"
      }
    ],
    "traceId": "{trace id}" 
  }
}

service_unavailable

Gateway / Partner service is unavailable

{
  "error": {
    "type": "GATEWAY_ERROR",
    "details": [
      {
        "field": "",
        "message": "Please hit periodically"
      }
    ],
    "traceId": "{trace id}" 
  }
}

service_unavailable

Gateway / Partner service is unavailable

{
  "error": {
    "type": "GATEWAY_ERROR",
    "details": [
      {
        "field": "",
        "message": "Please hit periodically"
      }
    ],
    "traceId": "{trace id}" 
  }
}

balance_insufficient

Merchant Balance is Insufficient

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Re Top-up your Balance"
      }
    ],
    "traceId": "{trace id}" 
  }
}

unsupported_channel_code

Channel Code is currently not supported

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "{field name}",
        "message": "Make sure channel code following on the API Document"
      }
    ],
    "traceId": "{trace id}" 
  }
}

general_error

General Error

{
  "error": {
    "type": "API_ERROR",
    "details": [
      {
        "field": "",
        "message": "Please contact our representative team"
      }
    ],
    "traceId": "{trace id}" 
  }
}
PreviousPayout BalanceNextRetrieve Inquiry Account