Payment

Schema #/components/schemas/Payment of contract 1.0.0-draft.14.

id Uuidrequiredread-only
Also used as the provider idempotency key.
Fields of id
Uuid
customerId Uuidrequiredread-only
Fields of customerId
Uuid
kind PaymentKindrequiredread-only
Fields of kind
PaymentKind
status PaymentStatusrequiredread-only
Fields of status
PaymentStatus
statusReason string | nullread-only
sourceBalanceId Uuidrequired
recipientId Uuid | null
recipient PaymentParty | null
amount Moneyrequired
sendAmount Money | null
quoteId Uuid | null
rate Rate | null
fees array of FeeLinerequiredread-only
totalDebit Moneyrequiredread-only
Fields of totalDebit
- amountMinor AmountMinorrequired
- currency CurrencyCoderequired
rail Railrequiredread-only
Fields of rail
Rail
reference stringrequired
max length 140
purposeCode string | null
max length 35
chargeBearer ChargeBearer | null
urgent booleanrequired
scheduledFor Date | null
estimatedArrival Timestamp | null
attachmentDocumentIds array of Uuid
approval object | nullread-only
Fields of approval
- approvalId Uuid
- requiredApprovals integer
- approvalsReceived integer
- status ApprovalStatus
providerRef string | nullread-only
Provider reference (e.g. UETR for SWIFT).
channel Channelrequiredread-only
Fields of channel
Channel
createdBy Uuidread-only
Fields of createdBy
Uuid
apiKeyId Uuid | null
submittedAt Timestamp | null
completedAt Timestamp | null
createdAt Timestamprequiredread-only
Fields of createdAt
Timestamp
updatedAt Timestampread-only
Fields of updatedAt
Timestamp
transactionId Uuid | null
metadata Metadata
processing PaymentProcessing