Payouts APIs

SUCCESS What’s New You can now initiate payouts directly to mobile numbers using the Payout Composite API

​

Payout APIs

The table below lists the various endpoints and gives a brief description of each:

​

API Endpoint | Description

​

Creates a Payout to a Bank Account | Create a payout to a bank account.

​

Create a Payout to a VPA | Creates a payout to a VPA.

​

Fetch a Payout with ID | Retrieves details of one payout via ID.

​

Fetch all Payouts | Retrieves details of all the payouts.

Cancel a Queued Payout | Cancels a payout in queued state.

​

Payout to Cards APIs

The table below lists the various endpoints and gives a brief description of each:

​

Payout Composite API

The table below lists the various endpoints and gives a brief description of each:

​

API Endpoint | Description

​

Create a Composite Payout to Mobile Number | Creates a payout to a contact’s mobile number.

​

Create a Composite Payout to Bank Account | Creates a payout to a contact’s bank account.

​

Create a Composite Payout to VPA | Creates a payout to a contact’s VPA (UPI).

Create a Composite Payout to Card | Creates a payout to a contact’s card.

​

Payout Approval API

The table below lists the various endpoints and gives a brief description of each:

​

API Endpoint | Description

​

Approve Payout | Approves the payout.

Reject Payout | Rejects the payout.

​

Payout Idempotency API

The table below lists the various endpoints and gives a brief description of each:

​

API Endpoint | Description

Request Idempotent Payout | Requests for an idempotent payout.

​

Transactions APIs

The table below lists the various endpoints and gives a brief description of each:

​

API Endpoint | Description

​

Fetch All Transactions | Retrieves all the transactions made from your business account.

Fetch Transaction with ID | Retrieves a particular transaction.

​

Payout Status Details

Status details are sent as part of the fetch payout API response and webhook payloads. It provides additional details about each payout status. A payout update webhook is sent every time an attribute in status details changes.

​

Related Information

• Payouts
• Fund Account APIs
• Subscribe to Webhooks