Bank Account Inquiry

POST 
/v2/disbursement/bank-account-inquiry

You can use this endpoint to get the bank account holder name. For now, it still take us a few seconds to do the inquiry. The result will be returned as a callback if we haven’t cached it yet. If it have been cached, you will get the result instantly. Be sure to set up your callback inquiry entry in your Flip for Business Dashboard.

Request

application/x-www-form-urlencoded

Body

required

account_number stringrequired

The account number of the bank account

bank_code stringrequired

Bank code of the account. Accepted value are listed above

inquiry_key string

Inquiry key for handling multiple request with multiple callback

Responses

200

Expected Response

application/json; charset=UTF-8

Schema

Schema

bank_code string

Bank code of the account

account_number string

Account number of the bank account

account_holder string

Name of the bank account holder

status string
Possible values are:
• PENDING: Inquiry still in process
• SUCCESS: Inquiry process is complete and bank account number is valid
• INVALID_ACCOUNT_NUMBER: Inquiry process is complete but the account number is invalid or maybe a virtual account number
• SUSPECTED_ACCOUNT: Bank account have been suspected on doing fraud. You still can do a disbursement to this account.
• BLACK_LISTED: Bank account have been confirmed on doing a fraud and therefore is blacklisted. You can’t do a disbursment to this account
• FAILED: The inquiry process is failed before we get the final status of the inquiry, e.g due to timeout or any other errors from the bank. If you get this response, please retry the inquiry to trigger reverification of the account.
• CLOSED: The inquiry process is complete and the account is valid, but it is closed/inactive so that it cannot receive money. You cannot do a disbursement to this account.
inquiry_key string

Inquiry key for handling multiple request with multiple callback

Example (from schema)

{
  "bank_code": "bca",
  "account_number": "5465327020",
  "account_holder": "PT Fliptech Lentera IP",
  "status": "SUCCESS",
  "inquiry_key": "aVncCDdKW9dciRvH9qSH"
}

401

Sample response when Your Flip api secret key value for Authorization is missing or invalid

application/json; charset=UTF-8

Schema

Schema

name string
message string
status integer

Example (from schema)

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "status": 401
}

422

Sample error response when you put invalid bank code

application/json; charset=UTF-8

Schema

Schema

code string

errors

object[]

Array [

attribute string

code integer

message string

]

Example (from schema)

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "bank_code",
      "code": 1033,
      "message": "Invalid bank code"
    }
  ]
}

Callbacks

POST bankAccountInquiryCallback

POST 
/your-callback-url

If our system has completed the bank account inquiry process, then we will hit the provided URL for the bank inquiry callback. Please make sure that you have set the Bank Account Inquiry callback URL on the Flip for Business dashboard.

application/x-www-form-urlencoded

Body

any

Callbacks Responses

200

Callback Received

Loading...