API Test Keys

Fetch Settlement Details

GET

/v1/transfers?expand[]=recipient_settlement

Click to copy

Use this endpoint to fetch details of settlements made to Linked Accounts. You should append ?expand[]=recipient_settlement as the query parameter to the fetch transfer request. This would return a settlement entity and the transfer entity.

Is this page helpful?

Curl

change language

1curl -X GET https://api.razorpay.com/v1/transfers?expand[]=recipient_settlement \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "trf_JCu3ZstilY6Whi",
7      "entity": "transfer",
8      "status": "failed",
9      "source": "pay_HWjY9DZSMsbm5E",
10      "recipient": "acc_CNo3jSI8OkFJJJ",
11      "amount": 100,
12      "currency": "MYR",
13      "amount_reversed": 0,
14      "fees": 0,
15      "tax": null,
16      "notes": {
17        "name": "Nur Aisyah",
18        "roll_no": "IEC2011026"
19      },
20      "linked_account_notes": [
21        "roll_no"
22      ],
23      "on_hold": false,
24      "on_hold_until": null,
25      "settlement_status": null,
26      "recipient_settlement_id": null,
27      "recipient_settlement": null,
28      "created_at": 1648556539,
29      "processed_at": 1648556543,
30      "error": {
31        "code": "BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
32        "description": "Account does not have sufficient balance to carry out transfer operation",
33        "reason": "insufficient_account_balance",
34        "field": "amount",
35        "step": "transfer_processing",
36        "id": "trf_JCu3ZstilY6Whi",
37        "source": null,
38        "metadata": null
39      }
40    },
41    {
42      "id": "trf_JCu3ZsTVSuy7oN",
43      "entity": "transfer",
44      "status": "failed",
45      "source": "pay_HWjY9DZSMsbm5E",
46      "recipient": "acc_CPRsN1LkFccllA",
47      "amount": 100,
48      "currency": "MYR",
49      "amount_reversed": 0,
50      "fees": 0,
51      "tax": null,
52      "notes": {
53        "name": "Siti Aisyah",
54        "roll_no": "IEC2011025"
55      },
56      "linked_account_notes": [
57        "roll_no"
58      ],
59      "on_hold": true,
60      "on_hold_until": 1671222870,
61      "settlement_status": null,
62      "recipient_settlement_id": null,
63      "recipient_settlement": null,
64      "created_at": 1648556539,
65      "processed_at": 1648556543,
66      "error": {
67        "code": "BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
68        "description": "Account does not have sufficient balance to carry out transfer operation",
69        "reason": "insufficient_account_balance",
70        "field": "amount",
71        "step": "transfer_processing",
72        "id": "trf_JCu3ZsTVSuy7oN",
73        "source": null,
74        "metadata": null
75      }
76    }
77  ]
78}

Query Parameters

expand

string

Used to retrieve settlement entity along with transfer entity. Supported value is recipient_settlement.

transfer_type

string

Applicable only if you are a Razorpay Partner. Controls which transfers are returned based on the destination account and partner configuration. Possible values are:

platform: Returns transfers excluding those sent to the partner's own Linked Accounts.
regular (or when the parameter is omitted): The behaviour depends on the partner's route_partnerships feature setting:
- If route_partnerships is enabled: Returns transfers sent to the partner's own Linked Accounts.
- If route_partnerships is disabled: Returns all regular transfers associated with the Partner account.

Response Parameters

id

string

Unique identifier of the transfer.

entity

string

The name of the entity. Here, it is transfer.

transfer_status

string

The status of the transfer. Possible values are:

created
pending
processed
failed
reversed
partially_reversed

settlement_status

string

The status of the settlement. Possible values are:

pending
on_hold
settled

source

string

Unique identifier of the transfer source. The source can be a payment or an order.

recipient

string

Unique identifier of the transfer destination, that is, the Linked Account.

amount

integer

The amount to be transferred to the Linked Account, in paise. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

string

ISO currency code. We support route transfers only in INR.

amount_reversed

integer

Amount reversed from this transfer for refunds.

notes

json object

Set of key-value pairs that can be associated with an entity. This can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.

on_hold

boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

true: Puts the settlement on hold.
false: Releases the settlement.

on_hold_until

integer

Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.

recipient_settlement_id

string

Unique identifier of the settlement.

recipient_settlement

array

Show child parameters (8)

linked_account_notes

array

List of keys from the notes object which needs to be shown to Linked Accounts on their Dashboard. For example, "region", "city". Only the keys will be shown, not values.

created_at

integer

Timestamp, in Unix, at which the transfer was created.

processed_at

integer

Timestamp, in Unix, at which the transfer was processed.

error

array

Provides error details that may occur during transfers.

Show child parameters (6)

source_channel

string

Medium through which transfers were created. For example, online.

Errors

The api key/secret provided is invalid

Error Status: 4xx

This error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the Dashboard.

Solution

Fetch Settlement Details

GET

/v1/transfers?expand[]=recipient_settlement

Click to copy

Is this page helpful?

Query Parameters

expand

string

Used to retrieve settlement entity along with transfer entity. Supported value is recipient_settlement.

transfer_type

string

Applicable only if you are a Razorpay Partner. Controls which transfers are returned based on the destination account and partner configuration. Possible values are:

platform: Returns transfers excluding those sent to the partner's own Linked Accounts.
regular (or when the parameter is omitted): The behaviour depends on the partner's route_partnerships feature setting:
- If route_partnerships is enabled: Returns transfers sent to the partner's own Linked Accounts.
- If route_partnerships is disabled: Returns all regular transfers associated with the Partner account.

Response Parameters

id

string

Unique identifier of the transfer.

entity

string

The name of the entity. Here, it is transfer.

transfer_status

string

The status of the transfer. Possible values are:

created
pending
processed
failed
reversed
partially_reversed

settlement_status

string

The status of the settlement. Possible values are:

pending
on_hold
settled

source

string

Unique identifier of the transfer source. The source can be a payment or an order.

recipient

string

Unique identifier of the transfer destination, that is, the Linked Account.

amount

integer

The amount to be transferred to the Linked Account, in paise. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

string

ISO currency code. We support route transfers only in INR.

amount_reversed

integer

Amount reversed from this transfer for refunds.

notes

json object

on_hold

boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

true: Puts the settlement on hold.
false: Releases the settlement.

on_hold_until

integer

Timestamp, in Unix, that indicates until when the settlement of the transfer must be put on hold. If no value is passed, the settlement is put on hold indefinitely.

recipient_settlement_id

string

Unique identifier of the settlement.

recipient_settlement

array

Show child parameters (8)

linked_account_notes

array

List of keys from the notes object which needs to be shown to Linked Accounts on their Dashboard. For example, "region", "city". Only the keys will be shown, not values.

created_at

integer

Timestamp, in Unix, at which the transfer was created.

processed_at

integer

Timestamp, in Unix, at which the transfer was processed.

error

array

Provides error details that may occur during transfers.

Show child parameters (6)

source_channel

string

Medium through which transfers were created. For example, online.

Errors

The api key/secret provided is invalid

Error Status: 4xx

This error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the Dashboard.

Solution

Curl

change language

1curl -X GET https://api.razorpay.com/v1/transfers?expand[]=recipient_settlement \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "trf_JCu3ZstilY6Whi",
7      "entity": "transfer",
8      "status": "failed",
9      "source": "pay_HWjY9DZSMsbm5E",
10      "recipient": "acc_CNo3jSI8OkFJJJ",
11      "amount": 100,
12      "currency": "MYR",
13      "amount_reversed": 0,
14      "fees": 0,
15      "tax": null,
16      "notes": {
17        "name": "Nur Aisyah",
18        "roll_no": "IEC2011026"
19      },
20      "linked_account_notes": [
21        "roll_no"
22      ],
23      "on_hold": false,
24      "on_hold_until": null,
25      "settlement_status": null,
26      "recipient_settlement_id": null,
27      "recipient_settlement": null,
28      "created_at": 1648556539,
29      "processed_at": 1648556543,
30      "error": {
31        "code": "BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
32        "description": "Account does not have sufficient balance to carry out transfer operation",
33        "reason": "insufficient_account_balance",
34        "field": "amount",
35        "step": "transfer_processing",
36        "id": "trf_JCu3ZstilY6Whi",
37        "source": null,
38        "metadata": null
39      }
40    },
41    {
42      "id": "trf_JCu3ZsTVSuy7oN",
43      "entity": "transfer",
44      "status": "failed",
45      "source": "pay_HWjY9DZSMsbm5E",
46      "recipient": "acc_CPRsN1LkFccllA",
47      "amount": 100,
48      "currency": "MYR",
49      "amount_reversed": 0,
50      "fees": 0,
51      "tax": null,
52      "notes": {
53        "name": "Siti Aisyah",
54        "roll_no": "IEC2011025"
55      },
56      "linked_account_notes": [
57        "roll_no"
58      ],
59      "on_hold": true,
60      "on_hold_until": 1671222870,
61      "settlement_status": null,
62      "recipient_settlement_id": null,
63      "recipient_settlement": null,
64      "created_at": 1648556539,
65      "processed_at": 1648556543,
66      "error": {
67        "code": "BAD_REQUEST_TRANSFER_INSUFFICIENT_BALANCE",
68        "description": "Account does not have sufficient balance to carry out transfer operation",
69        "reason": "insufficient_account_balance",
70        "field": "amount",
71        "step": "transfer_processing",
72        "id": "trf_JCu3ZsTVSuy7oN",
73        "source": null,
74        "metadata": null
75      }
76    }
77  ]
78}