Payouts APIs

Create Virtual Account

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payout/va

Method - POST

Field	Column	Value Type	Description
key	Required	string	PortOne client key
map_id	Required	string	merchant unique id
customer_name	Required	string	Name of Account Holder
channel_key	Required	string	channel to execute payouts from
bank_code	Required	string	bank code
personal_info	Optional	json	person information of the account holder
signature_hash	Required	string	HMAC SHA256 hash

personal_info

Field	Column	Value Type	Description
phone	Optional	string	phone no
email	Optional	string	email
address	Optional	string	address
id	Optional	string	merchant unique id for account holder

Sample cURL Request

curl --location --request POST 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payout/va' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"key":"SglffyyZgojEdXWL",

"map_id": "123423412312sadf3412234234123asd4",

"customer_name": "NGUYEN VAN A",

"channel_key": "EPAY_PAYOUT",

"bank_code": "WOORIBANK",

"personal_info": {

"phone": "0987654321",

"email": "abc@gmail.com",

"address": "Me Tri, Nam Tu Liem, Ha Noi",

"id": "1233211232sd3321"

},

"signature_hash":"iKNKyW1d0daILHo5H25wSfz9/D46mtSPpQ0mTuyxppM="

}'

Get List Virtual Accounts

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payout/va

Method - GET

Sample curl request

curl --location --request GET 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payout/va' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs'

Create Beneficiary

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payout/vendors

METHOD - POST

Field	Column	Value Type	Description
name	Required	string	Name of Beneficiary
email	Required	string	Email of Beneficiary
address		string	Address of Beneficiary
bank_account_number	Required	string	Beneficiary Bank Account Number
bank_account_name	Required	string	Beneficiary Bank Account Name
bank_name	Required	string	Beneficiary Bank Name
bank_account_type	Required	string	Beneficiary Bank Type - "0" for savings
bank_no	Required	string	Beneficiary Bank Number
signature_hash	Required	string	HMAC SHA256 hash

Sample curl request

curl --location --request POST 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payout/vendors' \

--header 'Content-Type: application/json' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--data-raw '{

"name": "Test",

"email": "test11@abc.com",

"phone": "+9112344567810",

"address": "Test Address",

"bank_account_number":"13210013240020",

"bank_account_name":"Nguyen Van A",

"bank_name":"WOORIBANK",

"bank_account_type": "0",

"bank_no":"970423",

"signature_hash":"iKNKyW1d0daILHo5H25wSfz9/D46mtSPpQ0mTuyxppM="

}'

Get List of Beneficiaries

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payout/vendors

METHOD - GET

Sample cURL Request

curl --location --request GET 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payout/vendors' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs'

Create Payouts

URL - https://api.portone.cloud/api/payout/transaction

METHOD - POST

Field	Column	Value Type	Description
virtual_acc_no	Required	string	Virtual Account Number
key	Required	string	PortOne Client Key
channel_key	Required	string	Payout Channel/Provider Key
txn_details	Required	array	Each element has PayoutTransaction details
signature_hash	Required	string	HMAC SHA256 hash

txn_details

Field	Column	Value Type	Description
txn_ref	Required	string	Merchant Unique Transaction Reference
bank_details	Required	json	Beneficiary bank details
trigger_time	Required	ISO format string	Payout Schedule Time
amount	Required	string	Amount to deposit
currency	Required	string	Currency of Amount
remarks		string	Remarks

bank_details

Field	Column	value type	Description
account_no	Required	string	Beneficiary Account Number
account_type	Required	string	Beneficiary Bank Type - "0" for savings
account_name	Required	string	Beneficiary Account Name
bank_no	Required	string	Beneficiary Bank Number
bank_name	Required	string	Beneficiary Bank Name
signature_hash	Required	string	HMAC-SHA256 hash

Sample cURL Request

curl --location --request POST 'https://api.portone.cloud/api/payout/transaction' \

--header 'Content-Type: application/json' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--data-raw '{

"virtual_acc_no": "902000225690",

"key": "SglffyyZgojEdXWL",

"channel_key": "EPAY_PAYOUT",

"signature_hash": "iKNKyW1d0daILHo5H25wSfz9/D46mtSPpQ0mTuyxppM=",

"txn_details": [

{

"txn_ref": "qwerty26",

"bank_details": {

"account_no": "288477738990000",

"account_type": "0",

"account_name": "Nguyen Van AA",

"bank_no": "970423",

"bank_name": "WOORIBANK"

},

"trigger_time": "2021-08-18T15:30:00Z",

"amount": 10000,

"currency": "VND",

"remarks": "Transfer new 1"

},

{

"txn_ref": "qwerty36",

"bank_details": {

"account_no": "288477738990000",

"account_type": "0",

"account_name": "Nguyen Van AA",

"bank_no": "970423",

"bank_name": "WOORIBANK"

},

"trigger_time": "2021-08-18T15:30:00Z",

"amount": 11000,

"currency": "VND",

"remarks": "Transfer new 2"

}

]

}'

Generate OTP

URL - https://api.portone.cloud/api/merchant/payout/approve/generateOTP

METHOD - POST

Field	Column	Value type	Description
approver_email	Required	string	Approver Email to get OTP

Sample curl request →

curl --location --request POST 'https://api.portone.cloud/api/merchant/payout/approve/generateOTP' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"approver_email":"teststaging1@gmail.com"

}'

Approve Payouts

URL → https://api.portone.cloud/api/merchant/payout/approve

METHOD → POST

Field	Column	Value Type	Description
approver_email	required	string	Approver Email Id
otp	required	string	OTP generated using no.6 API
approver_name	required	string	Approver Name
txn_refs	required	array	Transaction Refs to Approve
signature_hash	required	string	HMAC SHA256 hash

Sample curl request

curl --location --request POST 'https://api.portone.cloud/api/merchant/payout/approve' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"approver_email":"teststaging1@gmail.com",

"otp":"052316",

"approver_name":"teststaging1",

"txn_refs":["PARTNERTEST021631134187971232347", "PARTNERTEST021631134187965732348"],

"signature_hash": "iKNKyW1d0daILHo5H25wSfz9/D46mtSPpQ0mTuyxppM="

}'

Add Bank Account for Beneficiary

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payout/vendors/{beneficiary-uuid}/bank-accounts

METHOD - PUT

Sample curl request

curl --location --request PUT 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payout/vendors/aeee4466-8b50-47a0-9258-4528ff9aae07bank-accounts' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"bank_name": "WOORIBANK",

"bank_no": "970423",

"account_no": "13210013240010",

"account_type": "0",

"account_name": "Nguyen Van A",

"signature_hash":"iKNKyW1d0daILHo5H25wSfz9/D46mtSPpQ0mTuyxppM="

}'

Get List of Payouts

URL - https://api.portone.cloud/api/merchant/{portone-client-key}/payouts METHOD - POST

Sample curl request

curl --location --request POST 'https://api.portone.cloud/api/merchant/SglffyyZgojEdXWL/payouts' \

Get Virtual Account Balance

URL - https://api.portone.cloud/api/payout/va/{virtual-account-number}/balance METHOD - GET

Sample curl request

curl --location --request GET 'https://api.portone.cloud/api/payout/va/902000226613/balance' \

--data-raw ''

Get Payout Transaction Status

URL - https://api.portone.cloud/api/payout/{payout-transaction-ref}/status

METHOD - GET

Sample curl request

curl --location --request GET 'https://api.portone.cloud/api/payout/PARTNERTEST021627934064/status'

Update Payout Transaction Status

URL - https://api.portone.cloud/api/payout/{payout-transaction-ref}/status/Cancelled

METHOD - PUT

Sample curl request

curl --location --request PUT 'https://api.portone.cloud/api/payout/PARTNERTEST021630344800219941000/status/Cancelled'

Beneficiary Bank Account Verification

URL - https://api.portone.cloud/api/payout/vendor/account/verification

METHOD - POST

Field	Column	value type	description
chaipay_key	required	string	portone client key
channel_key	required	string	Provider/Channel to use
bank_number	required	string	Bank Number
account_number	required	string	Bank Account Number
account_name	required	string	Bank Account Name
request_id	required	string	Unique request Id
type	required	string	Account Type - can be "account"
signature_hash	required	string	HMAC SHA256 hash

Sample curl request

curl --location --request POST 'https://api.portone.cloud/api/payout/vendor/account/verification' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"chaipay_key":"SglffyyZgojEdXWL",

"channel_key":"EPAY_PAYOUT",

"bank_number":"970423",

"account_number":"13210013240000",

"account_name":"Nguyen Van A",

"request_id":"1234",

"type":"account",

"signature_hash":"Lz77W7aAVc8u/7EFaos5fE6df5jF16QQrbq6ClwDCZ8="

}'

Get Virtual Account Statement (Paginated)

URL - https://api.portone.cloud/api/payout/va/{virtual-account-number}/statement

METHOD - POST

Field	Column	Value Type	Description	Defaults
from	optional	string	From Date - ISO format, default is current time - 24 hours
to	optional	string	To Date - ISO format, default is current time
page	optional	string	page no, default is 1
pagesize	optional	string	pagesize, default is 10

Sample curl request

curl --location --request POST 'https://api.portone.cloud/api/payout/va/902000228288/statement' \

--header 'X-Portone-Client-Key: SglffyyZgojEdXWL' \

--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJpc3MiOiJDSEFJUEFZIiwic3ViIjoiY2hhaXBheV9jbGllbnRfaWQiLCJpYXQiOjE1MTYyMzkwMjIsImV4cCI6MTgzMDQwMDMxNn0.CJHQTY-6v5ILILamo13BhVdgK68AIH1oPwXYH4Iyffs' \

--header 'Content-Type: application/json' \

--data-raw '{

"from": "2021-08-20T13:00:00+05:30",

"to": "2021-10-20T14:00:00+05:30",

"page": 1,

"pagesize": 10

}'