Query Recipient Account list

POST /v3/b2b/recipient/list

Precautions: Get list of Recipients. By using optional search condition can filter the list of specified recipients. Results can be paginated, with maximum list limit of 200 results.

Request Sample

curl --location --request POST 'https://test2-business-cgi.pingpongx.com/v3/b2b/recipient/list' \
--header 'Authorization: Bearer a94890a8d16a4ba7b3ab64036d9624e189dd62e96aca480b91f824d0b5e0dcbe' \
--header 'Content-Type: application/json' \
--header 'timestamp: 1637564397860' \
--header 'sign: 4a70672b69b59d24d1ef05b716b1fc1d89e3e87e2b4921cb5847b6230e91c472' \
--header 'app_id: 80242303107221' \
--data-raw {
  "open_id": "b109676b6b874c33b0b9f6135e73dd8b",
  "account_type": "RECIPIENT_BANK",
  "card_no": "",
  "account_name": "",
  "currency": "USD",
  "status": "Approved",
  "page_no": "1",
  "page_size": "10"
}

Request Schema

Parameter	Type	Required	Description
open_id	String	M	User ID in PingPong
account_type	String	M	BENEFICIARY,RECIPIENT_BANK, RECIPIENT_PP
card_no	String	O	Account Number
account_name	String	O	Account Name in the bank detail
currency	String	O	Bank Account Currency
status	String	O	Beneficiary Account Status `PENDING,AVAILABLE,DECLINED`
page_no	Integer	M	Page number, starts from 1
page_size	Integer	M	Number of results per page, maximum value 200

Response Sample

{
  "code": 0,
  "message": "OK",
  "data" : {
    "total": 2,
    "pages": 1,
    "page_no": 1,
    "page_size": 50,
    "records": [
      {
        "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"
        }
      },
      {
        "biz_id": "ba011911200012205085",
        "status": "Approved",
        "holder_type": "Company",
        "account_type": "RECIPIENT_BANK",
        "create_time": "1621583473000",
        "bank_detail": {
          "currency": "USD",
          "account_name": "ppx",
          "country": "CA",
          "location": "Canada",
          "card_no": "456576583445345",
          "bank_name": "Bank of Montreal",
          "card_type": "CHECKING",
          "routing_no": "5677432"
        },
        "recipient_detail": {
          "recipient_type": "FreeLancer",
          "recipient_location": "Canada",
          "phone_prefix": "+86",
          "phone_no": "137xxxxxxxx"
        }
      }
    ]
  }
}

Response Schema

Parameter	Type	Description
total	Integer	Total records
pages	Integer	Totol number of page
page_no	Integer	Current page number
page_size	Integer	Number of results per page
records	List	List of recipients
recipient.biz_id	String	Recipient account unique id
recipient.status	String	Recipient account status ,`PENDING,AVAILABLE,DECLINED`
recipient.holder_type	String	Holder Account Type:PERSONAL, COMPANY
recipient.account_type	String	BENEFICIARY,RECIPIENT_BANK, RECIPIENT_PP
recipient.create_time	String	The time this recipient was created ,Unit milliseconds
records.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.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

Query Recipient Account List

Query Recipient Account list

results matching ""

No results matching ""