Inquiry Account

Inquire Payout beneficiary account information

Method and URL

POST [BASE_URL]/v1/inquiry-account

Request

Request Body

{
  "channelCode": "BCA",
  "channelInformation": {
    "accountNumber": "999966660001",
    "accountName": "Reforza Pivot"
  }
}

Detail Parameter Request

Parameter	Data Type	Character limit	Requirement	Description
channelCode	String	1-30	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	1-60	M	Account Number of payout destination
accountName	String	1-60	M	Account Name of payout destination from Merchant

Response

Response Body

{
  "code": "00",
  "message": "OK",
  "data": {
    "uuid": "f4f3b3d0-fbff-414a-9ec1-f2c279b4e0c6",
    "merchantId": "e485e01b-ff59-4a47-bb7d-9b39064f3388",
    "inquiryResult": {
      "status": "WARNING",
      "detail": "The account name entered does not match the bank's records. Please check the account information and try again. Bank record: Dummy Simulation"
    }
  }
}

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 the Inquiry Account API again, just pass inquiryId on the payload here