The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients 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.
Instructs Electrum to request an Industry Participant to credit an account at the partner. If the debtor (i.e. the Industry Participant's customer) agrees, an [https://bpp-developer-portal.redoc.ly/openapi/elpapi-bpp-partneroperation/inboundCreditTransfer/) will be performed to credit the account. If the Industry Participant or Industry Operator rejects the request, this will be communicated via an outboundRequestToPayResponse operation.
The Industry scheme may provide a confirmation that the request for a payment is to be presented to a payer prior to the payer accepting or rejecting the request for a payment. Where this is the case, such a confirmation is communicated by way of an outboundRequestToPayResponse operation.
| 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 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.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
Date and time at which the request to pay expires. Some schemes may still permit a payment after the request to pay expires. Upon expiry, the following schemes will reject an associated payment: ZA_RPP. The date must be formatted as defined by date-time in RFC3339
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent.
Agents between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2
Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.
An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.
An explanation of an EFT transaction, which will be printed on the debtor's statement for direct debits or the creditor's statement for credit transfers. Note that when populating a value for a direct debit, the first 10 characters must contain the Banks user code as configured at Bankserv. If configured, Electrum will populate this value automatically, in which case at most 20 characters should be used as a reference to avoid truncation.
Agent(s) between the debtor's agent and the instructing agent.
Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/request-to-pay \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"paymentScheme": {
"schema": "ZA_RPP"
},
"amounts": {
"bankSettlementAmount": {
"value": 100,
"currency": "ZAR"
}
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "PROPRIETARY",
"value": "PBPX"
}
},
"expiryDateTime": "2024-04-09T09:32:51.395+02:00",
"requestToPayConditions": {
"minAmount": {
"value": 100,
"currency": "ZAR"
},
"maxAmount": {
"value": 100,
"currency": "ZAR"
}
},
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"proxy": {
"schema": "MOBILE",
"value": "+27-721234567",
"namespace": "amazebank"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"creditorReference": {
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
},
"schema": "RequestToPay",
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
}
}'Accepted. RFC9110 - 202
No contentInstructs Electrum to notify an Industry Participant that a prior outboundRequestToPay operation should be cancelled if it's not yet been completed. This does not guarantee a cancellation however as the requested payment may have already been paid or rejected or expired etc. Whether the cancellation was successful or not is communicated via an [outboundRequestToPayCancellationResponse operation] (https://bpp-developer-portal.redoc.ly/openapi/elpapi-bpp-partner/operation/outboundRequestToPayCancellationResponse/). If the cancellation was successful, the status will be CANCELLED. Otherwise the status will reflect the current status of the RTP.
| 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
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
Contains key elements related to the original request to pay that is being referred to.
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 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.
The reason the request to pay is being cancelled.
AC03: InvalidCreditorAccountNumber - Wrong account number in Credit Transfer.AGNT: IncorrectAgent- Agent in the payment workflow is incorrect.AM09: WrongAmount- Amount is not the amount agreed or expected.BE16: InvalidDebtorIdentificationCode- Debtor or Ultimate Debtor identification code missing or invalid.COVR: CoverCancelledOrReturned- Cover payments has either been returned or cancelled.CURR: IncorrectCurrency- Currency of the payment is incorrect.CUST: RequestedByCustomer- Cancellation requested by the Creditor.CUTA: CancelUponUnableToApply- Cancellation requested because an investigation request has been received and no remediation is possible.DS24: TimeOut- Cancellation requested because the original payment order expired due to time-out.DT01: InvalidDate- Invalid date (for example, wrong or missing settlement date).DUPL: DuplicatePayment- Payment is a duplicate of another payment.FRAD: FraudulentOrigin- Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions.FRNA: ForwardToNextAgent- To complement a rejection response, suggesting the request for cancelation should be forwarded to the next agent in the payment transaction chain.FRTR: FinalResponse- Direct Debit Tracking recalled as Mandate CancelledINDM: IndemnityRequired- To express the wish to establish a bilateral indemnity agreement.MODT: ModifiedTransaction- The underlying transaction in relation to an RTP was modified.PAID: TransactionAlreadyPaid- The underlying transaction in relation to an RTP was already paid (via other means).SVNR: ServiceNotRendered- The payment is cancelled since a cash amount rendered was not correct or goods or a service was not rendered to the customer, e.g. in an e-commerce situation.SYAD: RequestToSettlementSystemAdministrator- Cancellation requested by System Member to Settlement System Administrator to indicate that the cancellation request must not be forwarded further in the chain.TECH: TechnicalProblem- Cancellation requested following technical problems resulting in an erroneous transaction.UPAY: UnduePayment- Payment is not justified.ENUE: EndUserError- Cancellation or request for return requested by the Debtor specifically due to one or more errors by debtor in the original Credit Transfer. Usage: This code can be used for any error in the original Credit Transfer made by the Debtor. Can also be used if multiple errors were made in the original Credit Transfer.UAPA: UnauthorizedPayment- "The Debtor is requesting a return of the payment because the payment was not properly authorized. Usage: This code can be used in the case where a Credit Transfer was made without proper authorization from the Debtor. This could be due to compromised end user credentials."NARR: Narrative- Reason is provided as narrative information in the additional reason information.AC02: InvalidDebtorAccountNumber- Debtor account number invalid or missing.BIAS: BatchInstructionAlreadySettled- Process a cancellation request but batch already settled.INCR: InvalidCancellationRequest- Process a cancellation request with incorrect reference to original batch.DRTP: DuplicationRequestToPay- Duplication of a request-to-pay message.curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/request-to-pay/cancellation-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"reasonCode": "CUST",
"schema": "RequestToPayCancellation",
"messageIdentifiers": {
"messageIdentification": "336b84c5592c3ebfa5553f6e191b6eaa",
"creationDateTime": "2022-05-04T03:05:10Z"
},
"originalMessageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"originalTransactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
}
}'Accepted. RFC9110 - 202
No contentThis synchronous operation is designed for retrieving the details of a request to pay.
A request to pay has various properties which may need to be retrieved at the time the payment is to be made and the request to pay may also transition through various states. At any time, this operation may be used to determine Electrum's latest view of the request to pay.
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
Holds a point-to-point unique message identification string as well as a message's creation date time.
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 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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/request-to-pay/get \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"instructedAgent": {
"additionalIdentifications": [
{
"accountKnownAs": "string",
"identifier": {
"schema": "string",
"value": "string"
},
"registeredSchemes": [
"ZA_RTC"
]
}
],
"bicfi": "string",
"branch": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"streetName": "string",
"townLocationName": "string",
"townName": "string"
},
"identification": "string",
"name": "string"
},
"companyRegistration": "string",
"lei": "string",
"memberId": "string",
"name": "string"
},
"instructingAgent": {
"additionalIdentifications": [
{
"accountKnownAs": "string",
"identifier": {
"schema": "string",
"value": "string"
},
"registeredSchemes": [
"ZA_RTC"
]
}
],
"bicfi": "string",
"branch": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"streetName": "string",
"townLocationName": "string",
"townName": "string"
},
"identification": "string",
"name": "string"
},
"companyRegistration": "string",
"lei": "string",
"memberId": "string",
"name": "string"
},
"messageIdentifiers": {
"creationDateTime": "2019-08-24T14:15:22Z",
"messageIdentification": "string"
},
"originalMessageIdentifiers": {
"creationDateTime": "2019-08-24T14:15:22Z",
"messageIdentification": "string"
},
"originalTransactionIdentifiers": {
"endToEndIdentification": "string",
"transactionIdentification": "string",
"uetr": "string"
},
"schema": "RequestToPayStatusRequest"
}'OK. RFC9110 - 200
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
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 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.
Contains key elements related to the original request to pay that is being referred to.
Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.
A list of RequestToPayStatusReasonInfo values providing detailed reason information for the status.
PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.EXPIRED: Expired - The request to pay has expired.PENDING: Pending - The request to pay has been forwarded and an intial status report is still expected.PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.REJECTED: Rejected - The request to pay has been rejected.REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcomeREFUNDED: Refunded - The refund of the original request to pay has been completed successfully{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "originalMessageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "transactionIdentifiers": { "endToEndIdentification": "string", "transactionIdentification": "string", "uetr": "string" }, "instructedAgent": { "additionalIdentifications": [ … ], "bicfi": "string", "branch": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "instructingAgent": { "additionalIdentifications": [ … ], "bicfi": "string", "branch": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "originalRequestToPayData": { "amounts": { … }, "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "expiryDateTime": "2019-08-24T14:15:22Z", "paymentTypeInformation": { … }, "remittanceInformation": { … }, "requestToPayConditions": { … } }, "requestToPayConditions": { "maxAmount": { … }, "minAmount": { … } }, "schema": "RequestToPayResponse", "status": { "reasonInfo": [ … ], "status": "PAID" } }
This operation is asynchronous. It is responded to by the outboundBulkRequestToPayResponse operation
Instructs Electrum to request multiple Industry Participants to credit multiple accounts at the partner. If the debtor associated with an RTP (i.e. the Industry Participant's customer) agrees, an inboundCreditTransfer operation will be performed to credit the account associated with that RTP. If the Industry Participant or Industry Operator rejects the request, this will be communicated via an outboundRequestToPayResponse operation. These responses will be sent via an async call with the operation outboundBulkRequestToPayResponse
The bulk status can be checked with the async request with operation getOutboundBulkRequestToPayStatus
| 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.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Universally unique identifier to identify the bulk collection itself.
List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Identification of a member of a clearing system.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
Date and time at which the request to pay expires. Some schemes may still permit a payment after the request to pay expires. Upon expiry, the following schemes will reject an associated payment: ZA_RPP. The date must be formatted as defined by date-time in RFC3339
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent.
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 reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.
Specifies the underlying reason for the payment transaction
Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
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 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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/bulk/request-to-pay \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "RequestToPayInitiation",
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"requestToPayInformationId": "5e3b27c8-3ac8-49d9-8f17-c2bdef7ca180",
"bulkPaymentSchemeName": "ZA_RPP",
"requestToPayInitiationInstructions": [
{
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId1",
"transactionIdentification": "RRN000000001",
"uetr": "e96b1217-b6c9-4e25-9877-fcc7aa845661"
},
"expiryDateTime": "2024-04-09T09:32:51.395+02:00",
"requestToPayConditions": {
"minAmount": {
"value": 100,
"currency": "ZAR"
},
"maxAmount": {
"value": 100,
"currency": "ZAR"
}
},
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"proxy": {
"schema": "MOBILE",
"value": "+27-721234567",
"namespace": "amazebank"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "PROPRIETARY",
"value": "PBPX"
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"creditorReference": {
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
}
}
],
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"numberOfTransactions": 1
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundBulkRequestToPayResponse operation
A query for information about a previously submitted outbound bulk request to pay initiation. This operation may be called at any time by the partner in order to query the state of the outbound request. If acknowledged by the server, the current status of the 'bulk' will be communicated to the partner via the outboundBulkRequestToPayResponse operation of the Partner API.
| 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.
A flag to indicate if the status of each individual request to pay, as per Electrum's view, should be reflected in the response
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
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
Universally unique identifier to identify the bulk collection itself.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/bulk/request-to-pay/status-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "RequestToPayInitiationStatusRequest",
"messageIdentifiers": {
"creationDateTime": "2024-05-04T03:01:01Z",
"messageIdentification": "messageId"
},
"originalMessageIdentifiers": {
"creationDateTime": "2024-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"requestToPayInformationId": "6e831b77-3e51-4a0e-a818-dc99a08f80d4",
"includeIndividualRequestToPayStatuses": false
}'Accepted. RFC9110 - 202
No contentThis 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. RefundInitiationRequest are also subject to a number of "refund" validations before the refund request is accepted for processing, such as:
RequestToPayRefundRequests.originalTransactionIdentifiers.uetrPAID state, indicating the initiator of the request-to-pay has received fundsDebtorAccount 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-pay's 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.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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
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 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 schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.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.
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 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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/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