List incoming payments

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

List and filter incoming payments.

See Pagination for more details.

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

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.

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

The type of the incoming payment.

direction

string

The direction of the incoming payment.

status

string

The status of the incoming payment.

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

The reconciliation status of the incoming payment.

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.

swift_gpi_tracking_id

uuid

Swift GPI tracking ID (UETR). Only applicable to swift and chaps payment types.

Responses

Response body

object

records

array of objects

required

records*

object

uuid

required

The UUID of the incoming payment.

status

string

required

The lifecycle stage of this incoming payment. It will be updated as the incoming payment is processed.

status_details

string

required

The details of the status of this incoming payment.

object

string

required

Defaults to incoming_payment

Type of the object, incoming_payment.

idempotency_key

string

required

An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.

bank_data

object

required

Bank data, such as message and transaction IDs, in JSON format.

reconciliation_status

string

required

The reconciliation status of the incoming payment, which is either unreconciled, reconciled, or partially_reconciled.

partially_reconciled reconciled unreconciled

reconciled_amount

int64

required

≥ 0

The reconciled amount.

created_at

date-time

required

The UTC timestamp of the creation of this incoming payment.

type

string

required

The type of payment. Only sepa and sepa_instant are supported for now.

sepa sepa_instant

direction

string

required

Defaults to credit

Either credit or debit. Describes the direction the money is flowing. A credit moves money from someone else's account to your account. A debit moves money from your account to someone else's account. An incoming payment of type:sepa and direction:credit is a SEPA Credit Transfer (SCT). An incoming payment of type:sepa and direction:debit is a SEPA Direct Debit (SDD). Only credit is supported for now.

credit

amount

int64

required

≥ 0

The absolute amount of a payment, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as 2000.

currency

string

required

The three-letter ISO 4217 currency code, in lowercase. Only EUR is supported for now.

EUR

connected_account_id

uuid

required

The ID of the connected account that receives the incoming payment.

originating_account

object

required

The originating account of the payment, for financial institution customers. This attribute is for financial institution customers only. It must be left empty for corporate customers.

receiving_account

object

required

The receiving account of the payment.

receiving_account_id

uuid

required

The ID of the internal account that receives the incoming payment.

reference

string

required

length ≤ 140

The reference that will appear on the origin and destination account statements, with a maximum of 140 characters.

value_date

date

required

The value date of the incoming payment.

requested_execution_date

date

required

The requested execution date of the incoming payment.

purpose

string

The purpose code of the incoming payment, ensuring compliance with regulatory requirements of certain beneficiary countries. Only applicable to swift and chaps payment types.

category_purpose_code

string

The category purpose of the incoming payment. Recommended for CHAPS payments.

swift_gpi_tracking_id

uuid

Swift GPI tracking ID (UETR). Only applicable to swift and chaps payment types.

direct_debit_mandate

object | null

required

The mandate authorizing the direct debit.

direct_debit_mandate_id

uuid

required

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

metadata

object

required

Additional client data in JSON format. See Metadata.

Has additional fields

intermediary_agents

array of objects

Intermediary financial institution agents via which the payment should be processed. Only applicable to swift payments.

intermediary_agents

object

name

string

Name of the intermediary agent.

bank_code

string

Bank code of the intermediary agent.

legal_entity_identifier

string

Legal entity identifier (LEI) of the intermediary agent.

other

string

Other identification of the intermediary agent.

routing_instruction

string

Specific instructions intended for the next financial institution in the payment chain to ensure proper processing of the transaction. Only applicable to swift payments.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.numeral.io/v1/incoming_payments?limit=25' \
3
     --header 'accept: application/json'

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

application/json

200200

400Validation error.