The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.
https://example.com/path/payments/api/v1/
This operation is asynchronous. It is responded to by the outboundRefundInitiationResponse operation.
Initiate the processing of a refund which must relate to a prior successful financial transaction. Non-financial transactions cannot be refunded. Movement of funds in the processing of the refund is in the opposite direction to the original financial transaction. Refunds are cleared according to the RefundInitiationRequest.paymentScheme. The prior successful financial transaction must be of the same payment scheme.
RTP-Refunds: Instructs Electrum to attempt to perform a refund for a prior outboundRequestToPay operation which was initiated by the Partner and paid by the recipient of the request-to-pay.
The original request-to-pay should be referenced through RefundInitiationRequest.originalTransactionIdentifiers.uetr. Refunds are processed as a new outboundCreditTransfer with Industry, using the new RefundInitiationRequest.transactionIdentifiers.uetr. Refunds are additionally subject to the same processing rules as other outbound financial payments. For example, if the refund recipients' account is closed, the refund will be rejected.
An outboundRefundInitiation operation is not guaranteed to be successful. A RefundInitiationRequest is also subject to a number of "refund" validations before the refund request is accepted for processing, such as:
RequestToPayRefundRequests.originalTransactionIdentifiers.uetr.PAID state, indicating the initiator of the request-to-pay has received funds.DebtorAccount values will be used when reserving funds for the new refund payment. If omitted, the CreditorAccount of the original payment will be used.NOTE: Refunds for inbound request-to-pays are not supported.
| Scheme | Applicable |
|---|---|
| ZA_RPP | ✓ |
| ZA_EFT | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
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 series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
Designates which scheme a refund initiation is associated with and describes scheme-specific information for the refund to be processed. Currently only ZA_RPP supported.
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.ZA_AC : South African Authenticated Collections scheme.ZA_RMS: South African Registered Mandate Service scheme.CBPR_PLUS: Cross-Border Payments and Reporting Plus.An explanation of the transaction, as assigned by the refund initiator, to unambiguously refer to this refund payment. This value will be used as the transaction reference if the clearing scheme supports it.
https://example.com/path/payments/api/v1/transactions/outbound/refund-initiation
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/refund-initiation \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"amounts": {
"bankSettlementAmount": {
"value": 50,
"currency": "ZAR"
},
"instructedAmount": {
"value": 50,
"currency": "ZAR"
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"schema": "RefundInitiationRequest",
"messageIdentifiers": {
"messageIdentification": "9fd51c7124ba4819b9253e296a6be1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "5129118655591098",
"transactionIdentification": "RRN000000002",
"uetr": "9f7a56ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"originalTransactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"paymentScheme": {
"schema": "ZA_RPP",
"schemeData": {
"hasRtp": true
}
}
}'Accepted. RFC9110 - 202
No content