v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

List Expected Payments

get/expected_payments

Query parameters

after_cursorstring
per_pageinteger
statusstring

One of unreconciled, reconciled, or archived.

internal_account_idstring

Specify internal_account_id to see expected_payments for a specific account.

directionstring

One of credit, debit

typestring

One of the Payment Types from Payment Orders

counterparty_idstring

Specify counterparty_id to see expected_payments for a specific account.

external_idstring

Specify external_id to see expected_payments matching a specific identifier.

amountinteger

Specify an amount to see expected_payments whose upper and lower bounds contain the value.

You can also use gte (>=), lte (<=) or eq (=) to filter by amount. For example, to see expected_payments whose bounds include amounts greater than or equal to $100, use amount%5Bgte%5D=10000.

metadatastring

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

created_at_lower_boundstring date-time

Filter expected payments created after the timestamp

created_at_upper_boundstring date-time

Filter expected payments created before the timestamp

updated_at_lower_boundstring date-time

Filter expected payments was last updated after the timestamp

updated_at_upper_boundstring date-time

Filter expected payments was last updated before the timestamp

entity_link_countstring

Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by entity_link_count. For example, for entity_link_count greater than 3, use entity_link_count%5Bgt%5D=3.

Response

OK