List expected payments

get

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

List and filter expected 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 expected payment.

end_date

date

The creation date of the expected payment.

start_expected_date

date

The expected date of the expected payment.

end_expected_date

date

The expected date of the expected payment.

direction

string

enum

The direction of the expected payment.

Allowed:

amount_from

int32

The amount of the expected payment.

amount_to

int32

The amount of the expected payment.

currency

string

The currency of the payment.

canceled

boolean

If true, only canceled expected payments will be fetched.

connected_account_id

uuid

The ID of the connected account related to the expected payment.

counterparty_account_number

string

deprecated

The account number of the counterparty, which can be the IBAN or any other identification provided by the bank.

external_account_number

string

The external account number, which can be the IBAN or any other identification provided by the bank.

counterparty_holder_name

string

deprecated

The name of the counterparty.

external_account_holder_name

string

The name of the external account holder.

description

string

The description of the expected_payment.

virtual_account_number

string

deprecated

The number of the virtual account linked to the expected payment.

internal_account_number

string

The number of the internal account of type virtual linked to the expected payment.

reconciliation_status

string

enum

The reconciliation status of the expected payment.

Allowed:

counterparty_id

uuid

deprecated

The ID of the counterparty of the expected payment.

external_account_holder_id

uuid

The ID of the external account holder.

counterparty_account_id

uuid

deprecated

The ID of the counterparty account of the expected payment.

external_account_id

uuid

The ID of the external account.

idempotency_key

string

Responses

200200

400400