An incoming payment is a payment received included in an incoming payment file, such as a pacs.008 file for incoming SEPA credit transfers (SCTs). Numeral receives incoming payment files from your bank and breaks them down into individual incoming payments. This feature is only available to financial institution customers.
| Attribute | Description |
|---|---|
| id string | The UUID of the incoming payment. |
| object string | The object, here incoming_payment. |
| connected_account_id string | The ID of the connected account that receives the incoming payment. |
| connected_account (deprecated) string | The ID of the connected account that receives the incoming payment. This field has been deprecated in favor of connected_account_id. |
| type string | Only sepa and sepa_instant are supported for now. |
| direction string | 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. |
| amount integer | The absolute value of the payment in the specified currency's smallest unit. For euro payments, the smallest unit is cents. €20 is represented as 2000. |
| currency string | The currency of the payment. Only EUR is supported for now. |
| reference string | The reference that will appear on the origin and destination account statements, with a maximum of 140 characters. |
| originating_account object | The account originating the payment. The object includes the following attributes:
|
| receiving_account object | The account receiving the payment. The object includes the following attributes:
|
| value_date date | The value date of the incoming payment. |
| status string | The lifecycle stage of this incoming payment. It will be updated as the incoming payment is processed. |
| status_details string | The details of the status of this incoming payment. |
| reconciliation_status string | The reconciliation status of the incoming payment, which is either unreconciled, reconciled or partially_reconciled. |
| reconciled_amount integer | The amount that is already reconciled. It is the sum of the amount of the reconciliations related to this incoming payment. |
| reconciliation_override boolean | If true, the incoming payment has been manually reconciled although the payment's reconciled_amount does not match the payment's amount. |
| metadata object | Additional data in JSON key:value format. Metadata. |
| bank_data object | Bank data, such as message and transaction IDs, in JSON key:value format. |
| created_at datetime | The UTC creation timestamp of the incoming payment. |
Below are examples of incoming_payment:
{
"id": "6607e355-7d2c-588b-9deb-403b0a91f89b",
"object": "incoming_payment",
"connected_account": "eca92b9e-6725-4233-9943-5e9bbf033e9c",
"connected_account_id": "eca92b9e-6725-4233-9943-5e9bbf033e9c",
"type": "sepa",
"direction": "credit",
"amount": 5000,
"currency": "EUR",
"reference": "Payment ID 1zVrqOXmCS",
"originating_account": {
"account_number": "FR7688511000011234567890107",
"bank_code": "BNPAFRPP",
"holder_name": "PartnerCo",
"holder_address": {
"line_1": "119, avenue du General Michel Bizot",
"line_2": "75012 Paris",
"postal_code": "",
"region_state": "",
"city": "Paris",
"country": "FR"
}
},
"receiving_account": {
"account_number": "FR7688511000011234567890107",
"bank_code": "SOGEFRPP",
"holder_name": "TechCo",
"holder_address": {
"line_1": "1, rue de la Paix",
"line_2": "",
"postal_code": "75001",
"region_state": "",
"city": "Paris",
"country": "FR"
}
},
"value_date": "2022-01-03",
"status": "received",
"status_details": "",
"reconciled_amount": 5000,
"reconciliation_status": "reconciled",
"reconciliation_override": false,
"metadata": {},
"bank_data": {
"end_to_end_id": "1zVrqOXmCS",
"file_id": "6fc0018b-4c4a-5d50-9f61-a054a1960bd9",
"message_id": "RirbvB2eEi",
"transaction_id": "1zVrqOXmCS"
},
"created_at": "2022-01-03T14:18:03.841642Z"
}
{
"id": "6607e355-7d2c-588b-9deb-403b0a91f89b",
"object": "incoming_payment",
"connected_account": "eca92b9e-6725-4233-9943-5e9bbf033e9c",
"connected_account_id": "eca92b9e-6725-4233-9943-5e9bbf033e9c",
"type": "sepa_instant",
"direction": "credit",
"amount": 5000,
"currency": "EUR",
"reference": "Payment ID 1zVrqOXmCS",
"originating_account": {
"account_number": "FR7688511000011234567890107",
"bank_code": "BNPAFRPP",
"holder_name": "PartnerCo",
"holder_address": {
"line_1": "119, avenue du General Michel Bizot",
"line_2": "75012 Paris",
"postal_code": "",
"region_state": "",
"city": "Paris",
"country": "FR"
}
},
"receiving_account": {
"account_number": "FR7688511000011234567890107",
"bank_code": "SOGEFRPP",
"holder_name": "TechCo",
"holder_address": {
"line_1": "1, rue de la Paix",
"line_2": "",
"postal_code": "75001",
"region_state": "",
"city": "Paris",
"country": "FR"
}
},
"value_date": "2022-01-03",
"status": "confirmed",
"status_details": "",
"reconciled_amount": 5000,
"reconciliation_status": "reconciled",
"reconciliation_override": false,
"metadata": {},
"bank_data": {
"end_to_end_id": "1zVrqOXmCS",
"file_id": "6fc0018b-4c4a-5d50-9f61-a054a1960bd9",
"message_id": "RirbvB2eEi",
"transaction_id": "1zVrqOXmCS"
},
"created_at": "2022-01-03T14:18:03.841642Z"
}