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/
The date when the account referenced by this proxy identifier was created.
Identifies this account identifier as generic, always GENERIC
Identifies the scheme that defines the identification of a generic account.
{ "creationDate": "2019-08-24T14:15:22Z", "proxy": { "namespace": "string", "schema": "string" }, "traditionalAccountType": { "schema": "string", "value": "CACC" }, "traditionalIdentifier": { "schema": "string", "value": "string" } }
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. |
{ "currency": "string", "value": 0.1 }
A report providing information from the lookup of a proxy in the context of the ZA RPP Payment Scheme.
This report returns information required to proceed with the clearing of funds through the use of the proxy (identifier) provided in the identifier determination request. Specifically, this report will provide the outcome of the lookup of said identifier, indication whether it is valid or not, as well as provide the name ("known as name") of the creditor, and the legal name of the creditor (both of these are mandatory in the ZA RPP Payment Scheme, despite not being mandatory in this API), namely:
accountOwner.knownAsNameaccountOwner.legalNameThis model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
AB06 : Transaction stopped due to timeout at the Instructed Agent.AB07 : Agent of message is not online. Generic usage if it cannot be determined who exactly is not online.AB10 : An error occured at the instructed agentAC06 : Account specified is blocked, prohibiting posting of transactions against itAG01 : Transaction forbidden on this type of accountAG03 : Transaction type not supported/authorized on this account.AG10 : Agent of message is suspended from the Real Time Payment system. Generic usage if it cannot be determined who exactly is suspended.AGNT : Agent in the payment workflow is incorrectAM02 : Specific transaction/message amount is greater than allowed maximum (e.g. payee proxy participant service limit exceededCH21 : Mandatory element is missing .DT02 : Invalid creation date and time in Group Header (eg, historic date) .DU03 : Transaction is not unique.DUPL : Request is a duplicate of another requestFF02 : Syntax error reason is provided as narrative information in the additional reason information.FF08 : End to End Id missing or invalid .NAUT : Permission to be processed is not grantedNOOR : Original SCT never receivedPD01 : Domain not found or invalidPD02 : Suspended Domain provided is suspended pending investigationBE23 : Phone number or email address, or any other proxy, used as the account proxy is unknown or invalid.PX03 : Proxy not found in central repositoryPX04 : Format of proxy invalidRC05 : BIC identifier is invalid or missing.RC08 : ClearingSystemMemberidentifier is invalid or missing. Generic usage if cannot specify between debit or credit account .RR10 : Character set supplied not valid for the country and payment type.RR12 : Invalid or missing identification required within a particular country or payment type.RF01 : Transaction reference is not unique within the message.AC16 : Account in SequestrationAC17 : Account in LiquidationAC04 : Account ClosedAC01 : Format of the account number specified is not correctMD07 : Account Holder DeceasedNOCM : Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing.BE01 : Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency).{ "accountAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "accountInformation": { "creationDate": "2019-08-24T14:15:22Z", "proxy": { … }, "traditionalAccountType": { … }, "traditionalIdentifier": { … } }, "accountOwner": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "outcome": "SUCCESSFUL", "reasonCode": "stri", "transactionLimit": { "currency": "string", "value": 0.1 } }