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/
An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.
This may be used by the following schemes:
{ "namespace": "string", "schema": "CUSTOM", "value": "string" }
An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.
This may be used by the following schemes:
{ "namespace": "string", "schema": "CUSTOM", "value": "string" }
CACC : Current - Account used to post debits and credits when no specific account has been nominated.CARD : Card Account - Account used for credit card payments.CASH : Cash Payment - Account used for the payment of cash.CHAR : Charges - Account used for charges if different from the account for payment.CISH : Cash Income - Account used for payment of income if different from the current cash account.COMM : Commission - Account used for commission if different from the account for payment.CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.LOAN : Loan - Account used for loans.MGLD : Marginal Lending - Account used for a marginal lending facility.MOMA : Money Market - Account used for money markets if different from the cash account.NREX : Non-Resident External - Account used for non-resident external.ODFT : Overdraft - Account is used for overdrafts.ONDP : Overnight Deposit - Account used for overnight deposits.OTHR : Other Account - Account not otherwise specified.SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.SLRY : Salary - Accounts used for salary payments.SVGS : Savings - Account used for savings.TAXE : Tax - Account used for taxes if different from the account for payment.TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.TRAS : Cash Trading - Account used for trading if different from the current cash account.CACC : Current - Account used to post debits and credits when no specific account has been nominated.CARD : Card Account - Account used for credit card payments.CASH : Cash Payment - Account used for the payment of cash.CHAR : Charges - Account used for charges if different from the account for payment.CISH : Cash Income - Account used for payment of income if different from the current cash account.COMM : Commission - Account used for commission if different from the account for payment.CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.LOAN : Loan - Account used for loans.MGLD : Marginal Lending - Account used for a marginal lending facility.MOMA : Money Market - Account used for money markets if different from the cash account.NREX : Non-Resident External - Account used for non-resident external.ODFT : Overdraft - Account is used for overdrafts.ONDP : Overnight Deposit - Account used for overnight deposits.OTHR : Other Account - Account not otherwise specified.SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.SLRY : Salary - Accounts used for salary payments.SVGS : Savings - Account used for savings.TAXE : Tax - Account used for taxes if different from the account for payment.TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.TRAS : Cash Trading - Account used for trading if different from the current cash account."CACC"