Developer Zone
These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Beneficiary Inquiry API

👍

HTTPS POST / Server-to-Server

Beneficiary registration requests and responses are encrypted using JWT with HS256 algorithm (HMAC with SHA-256) using Merchant’s Secret Key.

Merchants must know how to prepare requests and process responses using JWT Token.

https://sandbox-pgw.2c2p.com/payouts/api/v1.1/payout/beneficiary/inquiry 

https://pgw.2c2p.com/payouts/api/v1.1/payout/beneficiary/inquiry 

https://pgw.2c2p.com/payouts/api/v1.1/payout/beneficiary/inquiry

📘

API Parameter

Beneficiary Inquiry Parameter
Beneficiary Inquiry Response

Prepare Request

  1. Prepare payload data.
  2. Encrypt payload data with JWT - HS256 algorithm using merchant secret key.
{
  "merchantID": "702702000000001",
  "requestID": " 557f2de7-db81-40e9-9066-2821e7100a32",
  "BeneficiaryId": "payout_Prod_BFHsdwREMF7UulM9sYtgZSBg"

}


{
	"payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElEIjoiNzAyNzAyMDAwMDAwMDAxIiwicmVxdWVzdElEIjoiIDU1N2YyZGU3LWRiODEtNDBlOS05MDY2LTI4MjFlNzEwMGEzMiIsIkJlbmVmaWNpYXJ5SWQiOiJwYXlvdXRfUHJvZF9CRkhzZHdSRU1GN1V1bE05c1l0Z1pTQmcifQ.NveYEbQHruUTIRXahXuWjVx4SPkpn1SW5x7CiI5zO_c"
}
  1. Send request to beneficiary registration API.
curl --location --request POST 'https://sandbox-pgw.2c2p.com/payouts/api/v1.1/payout/beneficiary/inquiry' \
--header 'Content-Type: application/json' \
--data-raw '{
	"payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElEIjoiNzAyNzAyMDAwMDAwMDAxIiwicmVxdWVzdElEIjoiIDU1N2YyZGU3LWRiODEtNDBlOS05MDY2LTI4MjFlNzEwMGEzMiIsIkJlbmVmaWNpYXJ5SWQiOiJwYXlvdXRfUHJvZF9CRkhzZHdSRU1GN1V1bE05c1l0Z1pTQmcifQ.NveYEbQHruUTIRXahXuWjVx4SPkpn1SW5x7CiI5zO_c"
}'

Receive Response

  1. Receiving encrypted beneficiary data immediately.
  2. Decrypt payload data with JWT - HS256 algorithm using merchant secret key.
{
    "version": "1.1",
    "requestId": "591e6e59-dd19-4911-ae77-cf0043f4070b",
    "beneficiaryId": "payout_Prod_BFWW4eWRndEUmud88AQ_QHCw",
    "accountName": "NGUYEN van a",    
    "email": "[email protected]",
    "mobileNo": "",
    "bankCode": "AGRIBANK",
    "merchantId": "NINEPAY",
    "idCard": "",
    "companyId": null,
    "beneficiaryType": "",
    "beneficiaryTypeValue": "",
    "notificationUrl": "https://qaex6.2c2p.com/merchantclient/notification",
    "respCode": "8101",
    "respDesc": "Success – Payout request accepted",
    "remarks": null


}

{
	"payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ2ZXJzaW9uIjoiMS4xIiwicmVxdWVzdElkIjoiNTkxZTZlNTktZGQxOS00OTExLWFlNzctY2YwMDQzZjQwNzBiIiwiYmVuZWZpY2lhcnlJZCI6InBheW91dF9Qcm9kX0JGV1c0ZVdSbmRFVW11ZDg4QVFfUUhDdyIsImFjY291bnROYW1lIjoiTkdVWUVOIHZhbiBhIiwiZW1haWwiOiJtZXJjaGFudEBtZXJjaGFudHdlYi5jb20iLCJtb2JpbGVObyI6IiIsImJhbmtDb2RlIjoiQUdSSUJBTksiLCJtZXJjaGFudElkIjoiTklORVBBWSIsImlkQ2FyZCI6IiIsImNvbXBhbnlJZCI6bnVsbCwiYmVuZWZpY2lhcnlUeXBlIjoiIiwiYmVuZWZpY2lhcnlUeXBlVmFsdWUiOiIiLCJub3RpZmljYXRpb25VcmwiOiJodHRwczovL3FhZXg2LjJjMnAuY29tL21lcmNoYW50Y2xpZW50L25vdGlmaWNhdGlvbiIsInJlc3BDb2RlIjoiODEwMSIsInJlc3BEZXNjIjoiU3VjY2VzcyDigJMgUGF5b3V0IHJlcXVlc3QgYWNjZXB0ZWQiLCJyZW1hcmtzIjpudWxsfQ.BfDMaNwEKdh-BsnqdPsGA7sndxBOuFPvi6X2mturJSw"
}

Updated about 1 year ago