EPC API for receiving Electrum calls (17.1.0)

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.

Languages
Servers
Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-partner-redoc/

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

OrganisationIdentifierScheme

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
valuestringrequired
  • BANK : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
  • CBID : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.
  • CHID : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation
  • CINC : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.
  • COID : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)
  • CUST : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.
  • DUNS : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.
  • EMPL : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.
  • GS1G : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.
  • SREN : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
  • SRET : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity
  • TXID : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.
  • BDID : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.
  • BOID : BusinessOtherIdentification. Other identification of the organisation.
Enum"BANK""CBID""CHID""CINC""COID""CUST""DUNS""EMPL""GS1G""SREN"
{ "schema": "CODE", "value": "BANK" }

OrganisationIdentifierOther

A unique identification of an organisation, as assigned by an institution, using an identification scheme.

identificationstring<= 35 charactersrequired
issuerstring<= 35 characters

The name of the entity that assigns the identification

schemastringrequired

Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always OTHER

schemeobject(OrganisationIdentifierScheme)
{ "identification": "string", "issuer": "string", "schema": "string", "scheme": { "schema": "string", "value": "BANK" } }

OrganisationIdentifier

Holds identification details for an organisation.

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required
schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator
{ "BIC": "string", "schema": "BIC" }

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations