Get All Payments

get

https://api.zwitch.io/v1/accounts/{account_id}/payments

Use this API to get details of all payments made to an account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
The List All Payments API does not include details of payments made to savings and current accounts via methods such as NEFT, IMPS, RTGS, UPI, and cash deposits.

Path Params

account_id

string

required

Unique identifier of the account for which you want to get payment details.

Example: va_MDOShxKdcWpm7vEr2yDVb88EP

Query Params

start_after

string

The payment_id after which details should be returned.

Use this with the results_per_page for pagination.

Example: tx_13H35NkwDmSEy1AQTRmmvn8T6

start_before

string

The payment_id before which details should be returned.

Use this with the results_per_page for pagination.

Example: tx_13H35NkwDmSEy1AQTRmmvn8T6

results_per_page

string

Defaults to 10

The number of results you want to get per API call.

Use this with the start_before or start_after parameters for pagination.

Default value 10.
Maximum value 100.

Example: 15

from_date

string

Has to be used with to_date.

The UNIX timestamp after which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

to_date

string

Has to be used with from_date.

The UNIX timestamp before which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

merchant_reference_id

string

Unique identifier entered when creating the collect request.

Only alphabets and numbers are allowed.
Minimum: 7 characters.
Maximum: 40 characters.

Example: 1409614085

paid_mode

string

Payment mode used to complete the payment.

Possible values:

imps
neft
rtgs
upi
enach_mandate
upi_mandate
wallet
ift
open_payment_gateway

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧

200200

401401

422422