Payout API Documentation

A Payout API allows businesses to transfer money from their accounts to vendors, suppliers, employees, or customers automatically. This can include refunds, salary payments, vendor payouts, or instant rewards. Payout APIs are widely used in e-commerce, fintech, and corporate applications for seamless fund disbursement.

Key Features of a Payout API

Instant Transfers: Make real-time payments via multiple modes like NEFT, IMPS.

Bulk Payouts: Support for bulk disbursements using batch processing.

Automated Reconciliation: Real-time status updates for each transaction.

Workflow of a Payout API Integration

Beneficiary Management : Add or manage beneficiary details such as name, account number, and IFSC code.

Fund Transfer: Provide details like the amount, payout mode (IMPS, NEFT), and reference IDs.

Track Transaction Status: Use API endpoints or callback to check whether the payment was successful, failed, or is pending.

Reconciliation: Pull detailed transaction reports for accounting and reconciliation.

JWT Token Generate

A JSON Web Token (JWT) is a compact, self-contained method for securely transmitting information between parties as a JSON object.

This API Used to generate token for every new HTTP request.

POSTJWT Encode

https://payout.apiscript.in/jwt_encode

HEADERS

Content-Type

application/x-www-form-urlencoded

Bodyurlencoded

email_id

client@gmail.com

Pass client register email_id during API registration.

secret_key

3212-665df255d1202-234332

secret_key shared by APIScript Developer. After activation of API, APIScript Developer send email to client register email.

Example Request

curl

curl --location 'https://payout.apiscript.in/jwt_encode' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'email_id=client@gmail.com' \
--data-urlencode 'secret_key=3212-665df255d1202-234332'

200 OK

Example Response

plain

{
  "encode_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJUaW1lU3RhbXAiOiIxNzMxOTAwMzgyIiwiRW1haWxJRCI6ImluZm9AYXBpc2NyaXB0LmluIn0.EstqkmcqqyG7WjtpEnpS0RYIaHZIp0VpIDn8kPxG92U",
  "message": "Token generated successful",
  "error_code": 0
}

Server

nginx/1.18.0 (Ubuntu)

Date

Mon, 18 Nov 2024 03:26:22 GMT

Content-Type

text/plain; charset=utf-8

Transfer-Encoding

chunked

Connection

keep-alive

Strict-Transport-Security

max-age=2592000

X-Frame-Options

DENY

X-Content-Type-Options

nosniff

Beneficiary API

This API used to add beneficiary account.