Query Payee

Overview

Querying payees is used to view and manage created recipient information. By passing beneficiaryId or batch query conditions (such as country, currency, status, etc.), you can obtain detailed information of payees from the system (name, account, address, verification status, etc.).

Usage Scenario

This step is usually used to verify whether payee information is still valid before payment, or to synchronize the created recipient list between systems.

Query Methods

Method 1: Single Query

Precise Query:

• Query by beneficiaryId Payee Details Query Interface
• Get complete payee details
• Applicable for pre-payment verification

Method 2: Batch Query

List Query:

• Supports condition filtering Payee List Query Interface
• Supports pagination query
• Applicable for system synchronization and reconciliation

Single Query

Applicable Scenarios

Single query is used to get detailed information of a specified payee.

Scenario	Description
Verify Payee	Verify if payee was created successfully and is available
Pre-payment Verification	Before initiating payment, verify information corresponding to beneficiaryId
Review Status Check	Check review status

Operation Process

1. Step 1: Call query interface, pass beneficiaryId [Payee Details Query Interface]
2. Step 2: System returns detailed information
   • Basic information (name, country)
   • Account information (bank account number, bank code)
   • Review status
   • Creation time, update time
3. Step 3: Decide on action based on status
   • PASS → Can initiate payment Initiate Payment via Payee ID Interface
   • PROCESS → Wait for review
   • REJECT → Need to resubmit

Example Scenarios

Scenario 1: Finance Staff Verifying Information

• Query detailed payee information
• Confirm information is accurate and compliant
• Decide whether to approve payment

Scenario 2: System Automatic Verification

• User submits payment information
• System automatically verifies successful creation
• Display to operations staff for confirmation

Batch Query

Applicable Scenarios

Batch query is used to obtain information and lists of multiple payees, supports passing pagination and filtering parameters.

Scenario	Description
System Synchronization	Batch synchronize created payees to external accounting system
Status Monitoring	Regularly query payees' review status and batch verification
Financial Reconciliation	Confirm system information is consistent with Onerway platform

Operation Process

1. Step 1: Call batch query interface [Payee List Query Interface]
   • Can set filter conditions: Country, Currency, payee status (payeeStatus), pagination parameters (Size)
2. Step 2: System returns paginated list
   • Each record includes: beneficiaryId, name, account information, status, creation time
3. Step 3: Synchronize to internal system
   • For reconciliation
   • For batch distribution

Example Scenarios

Scenario 1: Daily Scheduled Synchronization

• Execute batch query every early morning
• Synchronize all payees created on that day
• Update internal system database

Scenario 2: Status Monitoring

• Regularly check status changes of all payees
• Identify: Pending review → Approved
• Trigger subsequent business processes

Scenario 3: Cross-team Collaboration

• Update shared payee library across teams
• Ensure information consistency across all teams
• Avoid duplicate creation

Query Method Comparison

Query Method	Applicable Scenario	Advantages	Recommended Frequency
Single Query	Confirm before initiating single payment	Immediate, accurate	Real-time call
Batch Query	Daily maintenance and synchronization	Full volume, traceable	Daily or weekly scheduled task

Notes

Important Reminder

1. Read-only Operation

   • Query interface is for read function only, does not affect payee's usage status

2. Data Consistency

   • Recommend combining system callbacks and regular queries to ensure complete and up-to-date information

3. Performance Optimization

   • Please use pagination for batch queries, avoid loading too much data at once

4. Security

   • Sensitive information (such as bank account numbers) may be partially masked

FAQ

Q1: If queried status is PROCESS, can payment be initiated?

Answer

No. Only payees with status PASS can be used for payment. PROCESS status indicates under review.

Q2: What is the maximum number of records for batch query?

Answer

It is recommended not to exceed 100 records per query, you can obtain all data through multiple paginated queries.

Q3: Is there a frequency limit for query interface?

Answer

Yes, it is recommended not to exceed 100 times/minute for single query, and not to exceed 10 times/minute for batch query.