List incoming payments

get

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

List and filter incoming payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

0 to 100

Defaults to 25

starting_after

uuid

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

The creation date of the incoming payment.

end_date

date

The creation date of the incoming payment.

connected_account_id

string

The ID of the connected account used to receive the payment.

type

string

enum

The type of the incoming payment.

Allowed:

direction

string

enum

The direction of the incoming payment.

Allowed:

status

string

enum

The status of the incoming payment.

Allowed:

start_value_date

date

The value date of the incoming payment.

end_value_date

date

The value date of the incoming payment.

amount_from

int32

≥ 0

The amount of the incoming payment.

amount_to

int32

≥ 0

The amount of the incoming payment.

currency

string

The ISO 4217 currency code of the incoming payment.

mandate_reference

string

length ≤ 35

The reference of the direct debit mandate.

file_id

uuid

The ID of the file including the incoming payment.

reconciliation_status

string

enum

The reconciliation status of the incoming payment.

Allowed:

aggregation_reference

string

length ≤ 140

The aggregation reference of the incoming payment.

direct_debit_mandate_id

uuid

The ID of the incoming payment’s direct debit mandate.

internal_account_id

uuid

The ID of the incoming payment’s receiving account.

uetr

uuid

Unique End-to-end Transaction Reference (UETR). Can be used to track payments with Swift GPI.

cbs_data.transaction_id

string

The ID of the transaction (transaction_id) in CBS Data (cbs_data).

validation.type

string

enum

The type of payment validation.

Allowed:

validation.status

string

enum

The status of payment validation.

Allowed:

Responses

200200

400Validation error.