Create new Recipient Account
- POST /v3/b2b/recipient/create
Precautions: A recipient account needs to be created before a payment can be made. A bizId is generated upon the creation can be used for creating Recipient payment(WITHDRAW, RECIPIENT, TRANSFER and Top up).
top up
withdrawal
send to recipientDetail
Request Sample
1:create a beneficiary bank account
curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/create' \
--header 'Authorization: Bearer a94890a8d16a4ba7b3ab64036d9624e189dd62e96aca480b91f824d0b5e0dcbe' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-raw
{
"open_id": "b109676b6b874c33b0b9f6135e73dd8b",
"holder_type": "Company",
"account_type": "BENEFICIARY",
"bank_detail": {
"currency": "USD",
"account_name": "ppxtest0524",
"location": "Australia",
"country": "AU",
"bank_name": "CITI Bank",
"card_no": "73455676878065633",
"card_type": "CHECKING",
"swift_code": "abcd1234",
"address": "HangZhou China"
},
"recipient_detail": {
"recipient_type": "FreeLancer",
"recipient_location": "HongKong",
"phone_prefix": "+86",
"phone_no": "1375824xxxx",
"email": "1375824xxxx@gmail.com",
"address": "HangZhou China",
"website": "www.pingpongx.com",
"contact_name": "Peter Wu"
}
}
2:create a recipient bank account
curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/create' \
--header 'Authorization: Bearer 2aa33376e7d741059234836fe88a3b0b9b9b56cdc8684351abd1764ffe604763' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-raw '{
"open_id": "c39bbfc034c943a3996ea7d579fdf204",
"holder_type": "Company",
"account_type": "RECIPIENT_BANK",
"bank_detail": {
"currency": "USD",
"account_name": "dan xu",
"location": "United States",
"country": "US",
"bank_name": "CITI bank",
"card_no": "2213847238999",
"routing_no": "123456789",
"card_type": "CHECKING"
},
"recipient_detail": {
"recipient_type": "FreeLancer",
"recipient_location": "HongKong",
"phone_prefix": "+86",
"phone_no": "1375824xxxx",
"email": "1375824xxxx@gmail.com",
"address": "HangZhou China",
"website": "www.pingpongx.com",
"contact_name": "Peter Wu"
}
}
3:create a recipient PingPong account
curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/create' \
--header 'Authorization: Bearer 2aa33376e7d741059234836fe88a3b0b9b9b56cdc8684351abd1764ffe604763' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-raw '{
"open_id": "c39bbfc034c943a3996ea7d579fdf204",
"holder_type": "Personal",
"account_type": "RECIPIENT_PP",
"recipient_detail": {
"recipient_type": "Other",
"recipient_location": "HongKong",
"pp_account": "testSeller0518@pp.com"
}
}
Request Schema
Parameter | Type | Required | Description |
---|---|---|---|
open_id | String | M | User ID in PingPong |
holder_type | String | M | Holder Account Type:PERSONAL, COMPANY |
account_type | String | M | BENEFICIARY: your own beneficiary bank account; RECIPIENT_BANK: recipient is a bank account; RECIPIENT_PP: recipient is a PingPong account |
bank_detail | Object | M | Recipient's bank account details where the payment will be credited |
bank_detail.currency | String | M | Bank Account Currency |
bank_detail.account_name | String | M | Bank Account Name |
bank_detail.card_no | String | M | Bank Account Number |
bank_detail.bank_name | String | M | Bank Name |
bank_detail.card_type | String | M | Bank Account Type: SAVINGS, CURRENT, CHECKING |
bank_detail.country | String | M | Bank Country Code (2-letter ISO 3166-2 country code),exmple:US |
bank_detail.location | String | M | Bank Country |
bank_detail.purpose_code | String | O | Bank Account Purpose |
bank_detail.account_holder_address | String | O | Account Holder Address |
bank_detail.contact_phone | String | O | Contact Phone |
bank_detail.nationality | String | O | Account Holder Nationality |
bank_detail.bank_code | String | O | Bank Code |
bank_detail.serial_no | String | O | Unique bank code set by the system |
bank_detail.branch_name | String | O | Branch Name |
bank_detail.branch_code | String | O | Branch Code |
bank_detail.IFSC_code | String | O | IFSC Code |
bank_detail.sort_code | String | O | Sort Code |
bank_detail.address | String | O | Bank Address |
bank_detail.province | String | O | Bank Province |
bank_detail.city | String | O | Bank City |
bank_detail.swift_code | String | O | Bank Swift Code |
bank_detail.routing_no | String | O | Bank Routing Number |
bank_detail.iban | String | O | Bank Iban |
bank_detail.certification_no | String | O | Certification Number |
recipient_detail | Object | O | when account type is RECIPIENT_BANK or RECIPIENT_PP is required |
recipient_detail.recipient_type | String | M | Procurement、Logistics、Warehousing、Operation agent、FreeLancer、Advertising、Other |
recipient_detail.recipient_location | String | M | Recipient Location |
recipient_detail.pp_account | String | O | Recipient is a PingPong account,when recipient account type is RECIPIENT_PP is required, example:xxxxxx@gmail.com |
recipient_detail.phone_prefix | String | O | International telephone code,example:+86 |
recipient_detail.phone_no | String | O | Phone Number |
recipient_detail.email | String | O | |
recipient_detail.address | String | O | Address |
recipient_detail.website | String | O | Website |
recipient_detail.contact_name | String | O | Recipient Name |
recipient_detail.partner_user_id | String | O | Partner platform`s user id |
Response Sample
{
"code": 0,
"message": "OK",
"data" : {
"biz_id": "ba011911200012205085",
"status": "AVAILABLE",
"holder_type": "Company",
"account_type": "RECIPIENT_BANK",
"create_time": "1621583473000",
"bank_detail": {
"currency": "USD",
"account_name": "ppx",
"country": "US",
"location": "United States",
"card_no": "73455676878065633",
"bank_name": "CITI Bank",
"card_type": "CHECKING",
"routing_no": "153464"
},
"recipient_detail": {
"recipient_type": "FreeLancer",
"recipient_location": "HongKong",
"phone_prefix": "+86",
"phone_no": "137xxxxxxxx",
"email": "xxxxxx@gmai.com",
"address": "xxxxxxx",
"website": "www.xxxx.com",
"contact_name": "Peter Wu"
}
}
}
Response Schema
Parameter | Type | Description |
---|---|---|
biz_id | String | recipient account unique id |
status | String | recipient account status ,PENDING,AVAILABLE,DECLINED |
holder_type | String | Holder Account Type:PERSONAL, COMPANY |
account_type | String | BENEFICIARY,RECIPIENT_BANK, RECIPIENT_PP |
create_time | String | The time this recipient was created ,Unit milliseconds |
bank_detail | Object | recipient's bank account details where the payment will be credited |
bank_detail.currency | String | Bank Account Currency |
bank_detail.account_name | String | Bank Account Name |
bank_detail.card_no | String | Bank Account Number |
bank_detail.bank_name | String | Bank Name |
bank_detail.card_type | String | Bank Account Type: SAVINGS, CURRENT, CHECKING |
bank_detail.purpose_code | String | Bank Account Purpose |
bank_detail.account_holder_address | String | Account Holder Address |
bank_detail.contact_phone | String | Contact phone |
bank_detail.nationality | String | Account Holder Nationality |
bank_detail.branch_name | String | Branch Name |
bank_detail.branch_code | String | Branch Code |
bank_detail.country | String | Bank Country Code (2-letter ISO 3166-2 country code),exmple:US |
bank_detail.location | String | Bank Country |
bank_detail.address | String | Bank Address |
bank_detail.province | String | Bank Province |
bank_detail.city | String | Bank City |
bank_detail.swift_code | String | Bank Swift Code |
bank_detail.routing_no | String | Bank Routing Number |
bank_detail.iban | String | Bank Iban |
bank_detail.certification_no | String | Certification Number |
recipient_detail | Object | when account type is RECIPIENT is required |
recipient_detail.recipient_type | String | Procurement、Logistics、Warehousing、Operation agent、FreeLancer、Advertising、Other |
recipient_detail.recipient_location | String | Recipient location |
recipient_detail.pp_account | String | Recipient is a PingPong account |
recipient_detail.phone_prefix | String | International telephone code,example:+86 |
recipient_detail.phone_no | String | Phone Number |
recipient_detail.email | String | |
recipient_detail.address | String | Address |
recipient_detail.website | String | Weibsite |
recipient_detail.contact_name | String | Recipient Name |
recipient_detail.partner_user_id | String | Partner platform`s user id |
tips:please download this docment to check the bank detail parameters Bank Rule