EPC API for calling Electrum (17.1.0)

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.

Download OpenAPI description
Overview
Languages
Servers
Mock server

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

Payments API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

Schema

PersonIdentificationCode

schemastringrequired

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

valuestringrequired
  • ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
  • CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
  • CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
  • DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
  • EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
  • NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
  • SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
  • TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
  • TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
  • POID: PersonOtherIdentification. Other identification of the person.
Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"
{ "schema": "string", "value": "ARNU" }

PersonIdentifierScheme

schemastringrequired

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

Discriminator
valuestringrequired
  • ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
  • CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
  • CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
  • DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
  • EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
  • NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
  • SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
  • TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
  • TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
  • POID: PersonOtherIdentification. Other identification of the person.
Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"
{ "schema": "CODE", "value": "ARNU" }

PersonIdentifier

identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

issuerstring<= 35 characters

The entity that assigns the identification

schemeobject(PersonIdentifierScheme)
{ "identification": "string", "issuer": "string", "scheme": { "schema": "string", "value": "ARNU" } }

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations