Search payments

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

SecurityoAuth2
Request
Request Body schema: application/json
paymentUUID
string

Payment unique identifier.

fromDate
string

From date. The valid date format is in [MM-dd-yyyy].

toDate
string

To date. The valid date format is in [MM-dd-yyyy]

currency
string

Payment currency. The valid country currency code should be per ISO 4217 standard.

minAmount
number

Minimum payment amount.

maxAmount
number

Maximum payment amount.

paymentAmount
number

Payment amount.

forexContractNo
string

FX contract number is present only for the internal payment

receiverAccountNo
string

Receiver's bank account number for the withdrawal of funds.

receiverName
string

Receiver bank account number to which money will be withdrawn.

senderName
string

Name of the sender linked to the payment.

senderAccountNo
string

Sender's bank account number from which money will be withdrawn.

sourceRefNo
string

Payment source reference number

status
string

Payment status, e.g. PROCESSED, TRANSMITTED_TO_FED, CANCELLED, FUTURE_DATED, PENDING_APPROVAL, PARTIALLY_APPROVED, APPROVED, etc...

wireType
string

Payment wire type e.g. OUTGOING_PAYMENT, INCOMING_PAYMENT

externalReferenceId
string

Unique reference id from a system outside of finzly.

senderAccountTokenId
string

A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the sender account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the sender to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.

receiverAccountTokenId
string

A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the receiver account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the receiver to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.

recurrenceId
number

Payment recurrence unique identifier

customerUID
number

Customer unique id

description
string

Payment note

receiverId
number

Payment receiver unique id

senderAccountId
string

Sender account unique id

mostRecent
boolean

When set to true, the response will be sorted in descending order by the payment date.

page
required
integer

What page of results should be returned? The minimum page size is 1.

limit
required
integer

Number of records to be included in each page. The minimum limit is 1 and the maximum limit is configurable in the system. If it is not configured then the default max limit is 100.

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
{
  • "paymentUUID": "1369308",
  • "fromDate": "03-25-2024",
  • "toDate": "04-25-2024",
  • "currency": "USD",
  • "minAmount": 100,
  • "maxAmount": 1000,
  • "paymentAmount": 120,
  • "forexContractNo": "13896558",
  • "receiverAccountNo": "2236569989",
  • "receiverName": "xyz",
  • "senderName": "corp",
  • "senderAccountNo": "2288556932",
  • "sourceRefNo": "839489343",
  • "status": "PROCESSED",
  • "wireType": "OUTGOING_PAYMENT",
  • "externalReferenceId": "Payment101",
  • "senderAccountTokenId": "1234567ABCD",
  • "receiverAccountTokenId": "ABCD734989",
  • "recurrenceId": 12898,
  • "customerUID": 234234,
  • "description": "Payment note",
  • "receiverId": 2899,
  • "senderAccountId": "57567567567",
  • "mostRecent": true,
  • "page": 1,
  • "limit": 10
}
Response samples
application/json
[
  • {
    }
]