APIs used in Integration
Use these APIs to onboard child merchants, create and inspect payment splits, release settlements, and manage split refunds.
Onboard child merchants
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Get Client Token API | OAuth scopes: refer_child_merchant, fetch_child_merchants | Generate a Hub OAuth token for child-merchant onboarding or listing. |
| Create Child Merchant API | refer_child_merchant scope | Onboard child merchants (sub-accounts) and update their bank details. |
| Sub Account Listing API | fetch_child_merchants scope | Fetch child merchant details linked to a parent merchant. Used in: Fetch Child Merchants Details and Integration APIs for Split Settlements. |
Split payments
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Absolute Split During Transaction | _payment | Split a payment by fixed amount among child merchants at transaction time. Used in: Absolute Split During Transaction Integration and Create the Split. |
| Split by Percentage During Transaction | _payment | Split a payment by percentage among child merchants at transaction time. Used in: Split by Percentage During Transaction Integration and Create the Split. |
| Absolute Split After Transaction | payment_split | Split a completed transaction by fixed amount. |
| Split by Percentage after Transaction | payment_split | Split a completed transaction by percentage. |
Release and reconcile settlements
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Release Settlement API | release_settlement | Release blocked settlement amounts for child merchants in the aggregator workflow. |
| Settlement Detail Range API | GET /settlement/range | Retrieve paginated transaction-level settlement details for a given date or date range. |
Retrieve transaction information
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Get Aggregator/Parent Transaction Info API | get_aggregator_transactions | Retrieve split allocation details for a parent transaction. |
| Get Child/Parent Split Transaction Info API | get_split_transactions | Retrieve split transaction details for child or parent merchants. |
| Get Split Info API | get_split_info | Fetch split information for a transaction. Used in: Integration APIs for Split Settlements and Create the Split. |
Manage refunds
| Use case → Reference | command / primary value | Description |
|---|---|---|
| Refund Transaction API | cancel_refund_transaction | Process refunds with var8 JSON specifying per-child refund amounts. |
| Refund Status API for Split Payments | aggregator_check_action_status_txnid | Check refund status for split-payment transactions. |
| Get All Refunds from Transaction IDs | getAllRefundsFromTxnIds | Retrieve all refunds associated with the supplied transaction IDs. |
Updated 20 days ago
Did this page help you?