The payment order object

A payment order is an order to create a payment to or out of one of your connected accounts. Numeral connects to your bank to process this payment and sends status updates through webhooks.

AttributeDescription
id
string
The UUID of the payment order.
object
string
The object, here payment_order.
connected_account_id
string
The ID of the connected account used to trigger the payment order.
connected_account (deprecated)
string
The ID of the connected account used to trigger the payment order.

This field has been deprecated in favor of connected_account_id.
type
string
The payment scheme or network. 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 your account to someone else's account. A debit moves money from someone else's account to your account.

A payment order of type:sepa and direction:credit is a SEPA Credit Transfer (SCT). A payment order 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 is the message that will appear on the origin and destination account statements, with a maximum of 140 characters.
originating_account
object
The account originating the payment.

This attribute must be filled by financial institution customers only. It must be left empty for corporate customers.

The object includes the following attributes:
  • account_number: for example, the IBAN.
    In case the account_number is an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder.
  • bank_code: for example, the BIC.
  • holder_name: the legal entity or individual name.
  • holder_address: the account holder address, as an address object.
receiving_account
object
The account receiving the payment.

The object includes the following attributes:
  • account_number: for example, the IBAN.
    In case the account_number is an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder.
  • bank_code: for example, the BIC.
  • holder_name: the legal entity or individual name.
  • holder_address: the account holder address, as an address object.
value_date
date
The value date of the payment order. The value date might be updated as the payment is processed by the bank as the CSM.
status
string
The lifecycle stage of this payment order. It will be updated as the payment order is processed.
status_details
string
The details of the status of this payment order.
reconciliation_status
string
The reconciliation status of the payment order, 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 payment order.
reconciliation_override
boolean
If true, the payment order 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. See Metadata.
bankdata
object
Bank data, such as message and transaction IDs, in JSON key:value format.
created_at
datetime
The UTC timestamp of the creation of this payment order.
updated_at
datetime
The UTC timestamp of the last update of this payment order.

A payment_order does not have an execution date. The execution date is the date when the payment is added to a payment file and sent to the bank, taking into consideration applicable cut-off time and calendar.

If you would like to schedule and execute a payment_order on a specific date, you should create it on this date, prior to the bank's cut-off time.

Below is an example of a payment_order:

{
  "id": "b69837bf-e784-4bd1-b0d0-2ad0e61a89b6",
  "object": "payment_order",
  "connected_account": "254e3100-afd6-44f2-8084-87e8ae67b554",
  "connected_account_id": "254e3100-afd6-44f2-8084-87e8ae67b554",
  "type": "sepa",
  "direction": "credit",
  "amount": 2000,
  "currency": "EUR",
  "reference": "Invoice 1234",
  "originating_account": {
    "account_number": "FR7601234567890627967100010",
    "bank_code": "SOGEFRPP",
    "holder_name": "SoftwareCo",
    "holder_address": {
      "line_1": "1, rue de l'Abondance",
      "line_2": "",
      "postal_code": "69003",
      "region_state": "",
      "city": "Lyon",
      "country": "FR"
    }
  },
  "receiving_account": {
    "account_number": "FR7601234567891127967100082",
    "bank_code": "BNPAFRPPXXX",
    "holder_name": "PartnerCo",
    "holder_address": {
      "line_1": "1, rue de la Bourse",
      "line_2": "",
      "postal_code": "59000",
      "region_state": "",
      "city": "Lille",
      "country": "FR"
    }
  },
  "value_date": "2022-01-03",
  "status": "executed",
  "status_details": "",
  "reconciled_amount": 2000,
  "reconciliation_status": "reconciled",
  "reconciliation_override": false,
  "metadata": {},
  "bank_data": {
    "file_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
    "message_id": "1gXrtKMxLJ",
    "transaction_id": "1zDrzOMxCJ",
    "end_to_end_id": "c3b2d737bc"
  },
  "created_at": "2022-01-03T11:53:19.734182Z",
  "updated_at": "2022-01-03T15:12:20.644356Z"
}