The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-partner-redoc/
https://example.com/path/payments/partner-api/v1/
A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
{ "numberOfAcceptedTransactions": 0, "numberOfCancelledTransactions": 0, "numberOfExpiredTransactions": 0, "numberOfPaidTransactions": 0, "numberOfPendingTransactions": 0, "numberOfPresentedTransactions": 0, "numberOfRejectedTransactions": 0, "numberOfUnsubmittedTransactions": 0 }
An extension of BaseMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.
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
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.Universally unique identifier to identify the bulk collection itself.
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 RequestToPayInstructionStatusReports relating to each request to pay initiation instruction received and actioned. Unsubmitted transactions will not be in this list.
A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
Count of transactions with the ACCEPTED status.
Count of transactions with the CANCELLED status.
Count of transactions with the EXPIRED status.
Count of transactions with the PAID status.
Count of transactions with the PENDING status.
Count of transactions with the PRESENT status.
Count of transactions with the REJECTED status.
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "originalMessageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "bulkPaymentSchemeName": "ZA_RTC", "numberOfTransactions": 1, "requestToPayInformationId": "string", "requestToPayInitiationStatus": { "outcome": "RECEIVED", "reasonInfo": [ … ] }, "requestToPayInstructionStatusReports": [ { … } ], "schema": "RequestToPayInitiationStatusRequest", "transactionStatistics": { "numberOfAcceptedTransactions": 0, "numberOfCancelledTransactions": 0, "numberOfExpiredTransactions": 0, "numberOfPaidTransactions": 0, "numberOfPendingTransactions": 0, "numberOfPresentedTransactions": 0, "numberOfRejectedTransactions": 0, "numberOfUnsubmittedTransactions": 0 } }