Search payments

Search payments based on various parameters. This operation retrieve limited payment data from the system

SecurityoAuth2
Request
Request Body schema: application/json
fromDate
string <date>

From date

toDate
string <date>

To date

currency
string

Payment currency

minPaymentAmount
number

Minimum payment amount

maxPaymentAmount
number

Maximum payment amount

forexContractNo
string

FX contract number

paymentType
string

Payment type

receiverAccountNo
string

Receiver account number

receiverName
string

Receiver name

senderName
string

Sender name associated with the payment.

senderAccountNo
string

Sender account number

sourceRefNo
string

Payment source reference number

status
string

Payment status

page
integer

Which page of results are to be returned

limit
integer

How many records are returned in the result set

Responses
200

Successfully processed request

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

post/v3/payments/search
Request samples
application/json
{
  • "fromDate": "2019-08-24",
  • "toDate": "2019-08-24",
  • "currency": "string",
  • "minPaymentAmount": 0,
  • "maxPaymentAmount": 0,
  • "forexContractNo": "string",
  • "paymentType": "string",
  • "receiverAccountNo": "string",
  • "receiverName": "string",
  • "senderName": "string",
  • "senderAccountNo": "string",
  • "sourceRefNo": "string",
  • "status": "string",
  • "page": 1,
  • "limit": 10
}
Response samples
application/json
[
  • {
    }
]