List payee verification requests

get

https://sandbox.numeral.io/v1/payee_verification_requests

List and filter payee verification requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 25

starting_after

string

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

Filter by creation date from.

end_date

date

Filter by creation date to.

status

string

enum

Filter by status.

Allowed:

direction

string

enum

Filter by direction.

Allowed:

scheme

string

enum

Filter by scheme.

Allowed:

payee_identification_type

string

The payee identification type used in the payee verification request.

payee_identification

string

The payee identification used in the payee verification request.

payee_account_number

string

The payee account number used in the payee verification request.

requesting_agent_bank_code

string

The requesting agent of the payee verification request.

responding_agent_bank_code

string

The responding agent of the payee verification request.

matching_result

string

enum

The matching result agent of the payee verification request.

Allowed:

internal_account_id

uuid

The ID of the internal account of the payee verification request.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200List of filtered payee verification requests

400Validation error.

500Internal server error.