This message is used to report information about the positive or negative status of a bulk payment initiation (Multiple Credit Transfers/Direct Debits)
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time
in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time
in RFC3339
A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Number of individual credit transfer instructions within the bulk that should be initiated.
Universally unique identifier to provide an end-to-end reference to the bulk initiation. This identifier remains the same for all messages related to the bulk transaction. Note: this is distinct from the UETR's of the individual credit transfers.
RECEIVED
: The bulk initiation has been received.PENDING
: The bulk initiation is undergoing pre-checks.ACCEPTED
: The bulk initiation has been accepted and individual transactions are being processed.COMPLETED
: The bulk initiation processing is complete, with all individual payment status reports received.REJECTED
: The bulk initiation has been rejected.
List of payment status reports relating to each credit initiation instruction received and actioned
Identifies the scheme used for the payment
ZA_RTC
: South African Realtime Clearing scheme.ZA_RPP
: South African Realtime Payments Platform scheme.ZA_EFT
: South African Electronic Funds Transfer scheme.CBPR_PLUS
: Cross-Border Payments and Reporting Plus.
A detailed breakdown of the number of transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
Count of transactions with the APPROVED
status.
Count of transactions with the CANCELLED
status.
Count of transactions with the PENDING
status.
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "originalMessageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "controlSum": { "currency": "string", "value": 0.1 }, "creditorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "debtorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "numberOfTransactions": 0, "paymentInformationId": "string", "paymentInitiationStatus": { "outcome": "RECEIVED", "reasonInfo": [ … ] }, "paymentInstructionStatusReports": [ { … } ], "paymentSchemeName": "ZA_RTC", "schema": "PaymentInitiationStatusReport", "transactionStatistics": { "numberOfApprovedTransactions": 0, "numberOfCancelledTransactions": 0, "numberOfPendingTransactions": 0, "numberOfRejectedTransactions": 0 } }