Create payment order

post

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

Create a payment order to be sent to the bank. Once created, a payment order can be approved or canceled.

Create payment orders in batches using the Bulk actions object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

const

enum

required

The type of payment.

Allowed:

direction

const

enum

required

The direction of the payment. 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.

Allowed:

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

const

enum

required

The ISO 4217 currency code of the payment order.

Allowed:

instructed_amount

int64

≥ 0

Instructed amount of the payment order, in the specified currency's smallest units. If not filled, it will contain the same value as the amount attribute. Mandatory when instructed_amount_currency is filled. Only applicable to swift and target2 payment orders sent from a connected account of type financial_institution.

instructed_amount_currency

string

Instructed amount currency of the payment order. ISO 4217 currency codes should be used. If not filled, it will contain the same value as the currency attribute. Only applicable to swift and target2 payment orders sent from a connected account of type financial_institution.

charges_information

array of objects

length ≤ 10

Charges or fees being applied to the payment order. Only applicable to swift and target2 payment orders sent from a connected account of type financial_institution.

charges_information

reference

string

required

length ≤ 140

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

end_to_end_id

string

length ≤ 35

The end-to-end ID of the payment order. Only supported for specific banks and payment schemes. Contact us to get more details.

connected_account_id

uuid

required

The ID of the connected account. The connected account is the account used to trigger the payment order.

originating_account

object

The account from which the payment originates. This field is required for financial institution customers. For corporate customers, this field is optional. If absent, the originating account is automatically derived from the connected account information. If present, the original account either represents the virtual account attached to the connected account or the 3rd party account.

originating_account_id

uuid

The ID of the internal_account sending the payment instruction. It must be left empty if the originating_account parameter is filled.

ultimate_originator

object

The ultimate originating account of the payment (sometimes called ultimate debtor for a credit transfer or ultimate creditor for a direct debit).

receiving_account

object

The account receiving the payment instruction. It must be left empty if receiving_account_id or direct_debit_mandate_id parameter is filled.

receiving_account_id

uuid

The ID of the external_account receiving the payment instruction. It must be left empty if receiving_account or direct_debit_mandate_id parameter is filled.

ultimate_receiver

object

The ultimate receiving account of the payment (sometimes called ultimate creditor for a credit transfer or ultimate debtor for a direct debit).

category_purpose_code

string

The category purpose of the payment. Recommended for chaps payments.

correspondent_bank_id

uuid

Correspondent bank ID, to override the automatically resolved correspondent bank with another one saved in your correspondent banks. Only applicable to swift payment orders created from a swift-direct connected account. Mutually exclusive with instructed_agent, which overrides the same correspondent bank with a BIC that is not saved in your correspondent banks, and with settlement_information.settlement_account.

correspondent_bank_account_id

uuid

Correspondent bank account ID, to override the automatically resolved correspondent bank account. Only applicable to swift payment orders created from a swift-direct connected account. Mutually exclusive with settlement_information.settlement_account, which overrides the same settlement account with an account number that is not saved in your correspondent bank accounts.

requested_execution_date

date

The requested execution date of the payment order.

auto_approval

boolean

Defaults to false

The auto_approval flag determines whether a payment requires human intervention before execution.

When true: The system bypasses all manual approval steps.

If a validation rule applies, the payment starts as pending_approval.
If no rules apply, the payment is immediately approved.

When false: The payment always starts as pending_approval and requires a manual user action. If a validation rule is also attached, it must be successfully completed before the payment can reach the final approved status.

retry_details

object

Information about the payment order retries.

confidentiality_option

string

enum

Used in case of a confidential payment. Only payroll confidential payments are supported for now.

Allowed:

cbs_transfer_allowed

boolean

Defaults to false

Indicates if the payment type could be promoted to a cbs_transfer.

lending

object

Manual lending flow parameters.

metadata

object

Additional client data in JSON format. See Metadata.

custom_fields

object

Custom fields in JSON key:value format. See Custom fields.

Headers

Idempotency-Key

string

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

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200200

400Validation error.

409Conflict.

415Unsupported Media Type.