Collection APIs

Collection APIs provide read and compliance-supplement access to incoming-funds (collection) transactions — the records created each time a payer wires money into one of your virtual accounts.

By integrating with these APIs, organizations can:

• Retrieve collection transaction details: Query any collection transaction by orderId to inspect the payer, amount, currency, order type, current status, and any trade orders that have already been matched to it.

• Supplement platform-collection compliance information: When a platform-collection transaction requires business-scenario and funds-nature classification (acquiring-institution or third-party-payment-receiver flows), submit the appropriate category codes and supporting documents to satisfy the platform's compliance requirements.

• Register and match trade orders: Submit PI/CI (Proforma Invoice / Commercial Invoice) trade-contract orders backed by contracts, logistics records, and product details, then match them against incoming collection transactions so each received payment is anchored to its corresponding commercial activity.

In essence, Collection APIs empower you to monitor every incoming payment, respond to compliance prompts, and link payments to their commercial background, keeping your funds moving through the Global Collections platform without unnecessary delays.

Supplement Payer Information and Submit Trade Detail File are not available — see the notices on those pages, linked in the table below. The Create Trade Order endpoint also has no schema-level (Zod) validation on the backend — see the hint on Create Trade Order. Supply Platform Collection Info has open questions around its requestId and bizScenario/fundsNature fields — see the warning on that page.

Endpoints

Endpoint	Method & Path	Status
Get Detail Collection Order	GET /v2/gc/collection-transactions	Available
Create Trade Order	POST /v2/gc/trade-orders	Available
Update Trade Order	PUT /v2/gc/trade-orders	Available
Match Collection and Trade Order	POST /v2/gc/trade-orders/collection-match-trade	Available
Supply Platform Collection Info	POST /v2/gc/platform/collection-transactions/supplement	Available
Webhook	—	Available