API | RazorpayX - Payouts Approval

You can approve payouts both on the RazorpayX Dashboard and via the API. Using the below mentioned endpoints, you can approve or reject payouts by their attributes.

Watch Out!

The approval API only works if the workflow has only one level of approval.

One of the approvers in this step has to be an owner.
Either the owner can be the sole approver or, the owner and another user can be the approvers.

Know more about

approval workflow

Explore the Payouts Approval API collection in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

Test API Keys

Prerequisites

Feature Request

This is an on-demand feature.

Contact support

to get this feature activated on your account.

Before you approve a payout or

use the below listed APIs

, you must:

Enable Approval Workflow by contacting our
support team
.
Be a Technology Partner
.
Integrate with OAuth
.

Then you can

create payouts

and approve or reject them.

List of Endpoints

Before you fire APIs, keep your Key id and Key Secret available. You can

generate API keys

in Live Mode or in

Test Mode

on the

RazorpayX Dashboard

API Endpoint	Description
Approve Payout	Approves the payout.
Reject Payout	Rejects the payout.

Errors

If you face errors during the process, refer to our

Errors

documentation for HTTP, 5xx and other errors.

Webhooks

payout.pending is Triggered whenever a payout moves to the pending state. The payout remains in this state till you approve or reject it.

The payload remains the same irrespective of the fund_account_type to which payout was made. That is, the payload is same whether the payout was made to a bank account, vpa or card.

{
  "entity": "event",
  "account_id": "acc_BfVUrG6tDiL7H0",
  "event": "payout.pending",
  "contains": [
    "payout"
  ],
  "payload": {
    "payout": {
      "entity": {
        "id": "pout_1Aa00000000001",
        "entity": "payout",
        "fund_account": {
          "id": "fa_F681qr6Bqy1Je7",
          "entity": "fund_account",
          "contact_id": "cont_F681qmU11CfPDl",
          "contact": {
            "id": "cont_F681qmU11CfPDl",
            "entity": "contact",
            "name": "Gaurav Kumar",
            "contact": "9876543210",
            "email": "gaurav.kumar@example.com",
            "type": "employee",
            "reference_id": "Acme Contact ID 12345",
            "batch_id": null,
            "active": true,
            "notes": {
              "notes_key_1": "Tea, Earl Grey, Hot",
              "notes_key_2": "Tea, Earl Grey… decaf."
            },
            "created_at": 1592929016
          },
          "account_type": "bank_account",
          "vpa": {
            "username": "gaurav.kumar",
            "handle": "exampleupi",
            "address": "gaurav.kumar@exampleupi"
          }
        },
        "batch_id": "null",
        "active": true,
        "created_at": 1592929016
      },
      "amount": 100,
      "currency": "INR",
      "notes": {
        "note_key 1": "Tea. Earl Gray. Hot.",
        "note_key 2": "Tea. Earl Gray. Decaf."
      },
      "fees": 0,
      "tax": 0,
      "status": "pending",
      "purpose": "refund",
      "utr": null,
      "mode": "NEFT",
      "reference_id": null,
      "narration": "Test Fund Transfer",
      "batch_id": null,
      "status_details": {
        "description": "Confirmation of the credit to the beneficiary is pending from HDFC bank. Please check the status after 24th October 2021, 10:40 PM",
        "source": "beneficiary_bank"
      },
      "created_at": 1580808301
    }
  }
}

Know more about

Webhooks

and other

Payloads

Payouts Approval API

Prerequisites

List of Endpoints

Errors

Webhooks

Related Information