Initiate Settlement Command (v1)

Command to initiate settlement process for a payment

Command

Architecture

Schema

Message Schema

28 properties

Base type for all commands in the system

id string
required

Unique identifier for the message, typically a UUID

paymentId string <uuid>
required

Payment unique identifier in version 4 UUID format

debtorName string
required

Name of the debtor

debtorAccount object
required

Contains account details used in the settlement process

debtorAddress object

Contains the address details

creditorName string
required

Name of the creditor

creditorAccount string → SettlementAccount ❌ ref not found
required

Reference to #/components/schemas/SettlementAccount (definition not found in root schema)

Title: SettlementAccount

creditorAgent string

Agent of the creditor (e.g. BIC)

creditorAddress string → Address ❌ ref not found

Reference to #/components/schemas/Address (definition not found in root schema)

Title: Address

instructedAmount object
required

Contains the payment amount and currency code

endToEndIdentification string

Unique identifier used to track and reconcile the payment throughout the payment chain

remittanceInformationUnstructured string

Additional details about the payment