Query Recipient Account by ID

  • POST /v3/b2b/recipient/get

    Precautions: Get a specific beneficiary/recipient by specifying the PingPong bizId.

Request Sample

curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/get' \
--header 'Authorization: Bearer a94890a8d16a4ba7b3ab64036d9624e189dd62e96aca480b91f824d0b5e0dcbe' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-row {
"open_id":"b109676b6b874c33b0b9f6135e73dd8b",
"biz_id": "ba011911200012205085"
}

Request Schema

Parameter Type Required Description
open_id String M User ID in PingPong
biz_id String M Unique of the recipient contact to retrieve

Response Sample

{
  "code": 0,
  "message": "OK",
  "data" : {
    "biz_id": "ba011911200012205085",
    "status": "Approved",
    "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 Beneficiary account unique id
status String Beneficiary 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 Beneficiary'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 Email
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
Copyright © pingpongx.com 2021 all right reserved,powered by Gitbooklast modified: 2021-11-23 10:08:57

results matching ""

    No results matching ""