Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

X

Payout Wallet

Entity

API Test Keys

Payout Wallet Entity

The Contact, Fund Account and Payout Entities have the following parameters:

Is this page helpful?

Sample Entity (Composite Payout)

1
{
2
    "id": "pout_00000000000001",
3
    "entity": "payout",
4
    "fund_account_id": "fa_00000000000001",
5
    "fund_account": {
6
        "id": "fa_00000000000001",
7
        "entity": "fund_account",
8
        "contact_id": "cont_00000000000001",
9
        "contact": {
10
            "id": "cont_00000000000001",
11
            "entity": "contact",
12
            "name": "Gaurav Kumar",
13
            "contact": "9876543210",
14
            "email": "gaurav.kumar@example.com",
15
            "type": "employee",
16
            "reference_id": "Acme Contact ID 12345",
17
            "batch_id": null,
18
            "active": true,
19
            "notes": {
20
                "notes_key_1": "Tea, Earl Grey, Hot",
21
                "notes_key_2": "Tea, Earl Grey… decaf."
22
            },
23
            "created_at": 1580817353
24
        },
25
        "account_type": "wallet",
26
        "wallet": {
27
            "provider": "amazonpay",
28
            "phone": "+919876543210",
29
            "email": " gaurav.kumar@example.com",
30
            "name": "Gaurav Kumar"
31
        },
32
        "batch_id": null,
33
        "active": true,
34
        "created_at": 1581080272
35
    },
36
    "amount": 1000000,
37
    "currency": "INR",
38
    "notes": {
39
        "notes_key_1": "Beam me up Scotty",
40
        "notes_key_2": "Engage"
41
    },
42
    "fees": 590,
43
    "tax": 90,
44
    "status": "processed",
45
    "purpose": "payout",
46
    "utr": "GCID1234567",
47
    "mode": "amazonpay",
48
    "reference_id": "Acme Transaction ID 12345",
49
    "narration": "Acme Corp Fund Transfer",
50
    "batch_id": null,
51
    "status_details": null,
52
    "created_at": 1581499319
53
}
id
string

The unique identifier of the order.

entity
string

The entity being created. Here, it will be payout.

fund_account_id
string

The unique identifier linked to the fund account. For example, fa_00000000000001.

fund_account
object

Contact and fund account details to which the payout was made.

Show child parameters (9)

amount
integer

The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value 100.

The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.

currency
string

The payout's currency. Here, it is INR.

notes
array of objects

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

fees
integer

The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.

tax
integer

The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the processing state. For example, 1.

status
string

The status of the payout. Possible payout states:

Refer to

Payout Life Cycle

.

purpose
string

The purpose of the payout that is being created. The following classifications are available in the system by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

Additional purposes for payouts can be created via the

RazorpayX Dashboard

and then used in the API. However, it is not possible to create a new purpose for the payout via the API.

utr
string

The unique transaction number linked to a payout. For example, GCID1234567.

mode
string

The mode used to make the payout. Available modes is amazonpay. The payout modes are case-sensitive.

reference_id
string

A user-generated reference given to the payout. Maximum length is 40 characters. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration
string

Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space.

You cannot enter a custom narration when creating a payout via Amazon Pay.

batch_id
string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

status_details
object

This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

Show child parameters (3)

created_at
integer

Indicates the Unix timestamp when this order was created. For example, 1545320320.

Payout Wallet Entity

The Contact, Fund Account and Payout Entities have the following parameters:

Is this page helpful?

id
string

The unique identifier of the order.

entity
string

The entity being created. Here, it will be payout.

fund_account_id
string

The unique identifier linked to the fund account. For example, fa_00000000000001.

fund_account
object

Contact and fund account details to which the payout was made.

Show child parameters (9)

amount
integer

The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value 100.

The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.

currency
string

The payout's currency. Here, it is INR.

notes
array of objects

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty".

fees
integer

The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.

tax
integer

The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the processing state. For example, 1.

status
string

The status of the payout. Possible payout states:

Refer to

Payout Life Cycle

.

purpose
string

The purpose of the payout that is being created. The following classifications are available in the system by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

Additional purposes for payouts can be created via the

RazorpayX Dashboard

and then used in the API. However, it is not possible to create a new purpose for the payout via the API.

utr
string

The unique transaction number linked to a payout. For example, GCID1234567.

mode
string

The mode used to make the payout. Available modes is amazonpay. The payout modes are case-sensitive.

reference_id
string

A user-generated reference given to the payout. Maximum length is 40 characters. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration
string

Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space.

You cannot enter a custom narration when creating a payout via Amazon Pay.

batch_id
string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

status_details
object

This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

Show child parameters (3)

created_at
integer

Indicates the Unix timestamp when this order was created. For example, 1545320320.

Sample Entity (Composite Payout)

1
{
2
    "id": "pout_00000000000001",
3
    "entity": "payout",
4
    "fund_account_id": "fa_00000000000001",
5
    "fund_account": {
6
        "id": "fa_00000000000001",
7
        "entity": "fund_account",
8
        "contact_id": "cont_00000000000001",
9
        "contact": {
10
            "id": "cont_00000000000001",
11
            "entity": "contact",
12
            "name": "Gaurav Kumar",
13
            "contact": "9876543210",
14
            "email": "gaurav.kumar@example.com",
15
            "type": "employee",
16
            "reference_id": "Acme Contact ID 12345",
17
            "batch_id": null,
18
            "active": true,
19
            "notes": {
20
                "notes_key_1": "Tea, Earl Grey, Hot",
21
                "notes_key_2": "Tea, Earl Grey… decaf."
22
            },
23
            "created_at": 1580817353
24
        },
25
        "account_type": "wallet",
26
        "wallet": {
27
            "provider": "amazonpay",
28
            "phone": "+919876543210",
29
            "email": " gaurav.kumar@example.com",
30
            "name": "Gaurav Kumar"
31
        },
32
        "batch_id": null,
33
        "active": true,
34
        "created_at": 1581080272
35
    },
36
    "amount": 1000000,
37
    "currency": "INR",
38
    "notes": {
39
        "notes_key_1": "Beam me up Scotty",
40
        "notes_key_2": "Engage"
41
    },
42
    "fees": 590,
43
    "tax": 90,
44
    "status": "processed",
45
    "purpose": "payout",
46
    "utr": "GCID1234567",
47
    "mode": "amazonpay",
48
    "reference_id": "Acme Transaction ID 12345",
49
    "narration": "Acme Corp Fund Transfer",
50
    "batch_id": null,
51
    "status_details": null,
52
    "created_at": 1581499319
53
}