Payout APIs

Verify Beneficiary Account

post/api/payout/vendor/account/verification

Request

Base URL
https://api.portone.cloud
URL
https://api.portone.cloud/api/payout/vendor/account/verification
Auth
none declared

Headers

X-Portone-Client-Keystring

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

portone_keystring required

The unique PortOne key for merchant

channel_keystring required

The Payment Channel Key listed in PortOne docs

bank_namestring required

The bank name where the Beneficiary has their bank account

bank_numberstring required

The bank number of the Beneficiary

account_numberstring required

The account number of the Beneficiary

account_namestring required

The account name of the Beneficiary

request_idstring required

The request_id of verification request

type'BANK' | 'CARD' required

The account type of the Benificiary

signature_hashstring

The SignatureHash generated for the specific payload data

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "portone_key": "SglffyyZgojEdXWL",
  "channel_key": "EPAY_PAYOUT",
  "bank_number": "970423",
  "account_number": "13210013240000",
  "account_name": "Nguyen Van A",
  "request_id": "1234",
  "type": "account",
  "environment": "sandbox",
  "signature_hash": "cyrcYRdrADrtdAdrsrdr/gyuGYUafdtuftftftft"
}

Response

Successful response

is_verifiedstring

The boolean flag indicating whether the beneficiary account is verified or not.

bank_numberstring

The bank number mapped with the beneficiary account.

account_numberstring

The account number of the beneficiary.

account_namestring

The name of the beneficiary account.

request_idstring

The request_id for verification generated by PSP.

Changes

No recorded changes to this operation across all 1 revision of this API.