PartyIdentification

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.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

PersonIdentification

identifiersArray of objects(PersonIdentifier)required

identifiers[].identificationstring<= 35 charactersrequired

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

identifiers[].issuerstring<= 35 characters

The entity that assigns the identification

identifiers[].schemeobject(PersonIdentifierScheme)

schemastringrequired

Identifies the party as a person, always PERSON

{
  "identifiers": [
    { … }
  ],
  "schema": "string"
}

PartyIdentification

The identification of a party, either a person or an organisation.

identifiersArray of objects(OrganisationIdentifier)required

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

identifiers[].schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

schemastringrequired

Identifies the party as an organisation, always ORGANISATION

Discriminator

{
  "identifiers": [
    { … }
  ],
  "schema": "ORGANISATION"
}

Party

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

addressobject(PostalAddress)

contactDetailsobject(ContactDetails)

countryOfResidencestring(CountryCode)[A-Z]{2,2}

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).

identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

knownAsNamestring[ 1 .. 140 ] characters

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.

legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

{
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "room": "string",
    "streetName": "string",
    "subDepartment": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "contactDetails": {
    "emailAddress": "user@example.com",
    "mobileNumber": "string",
    "phoneNumber": "string"
  },
  "countryOfResidence": "string",
  "identification": {
    "identifiers": [ … ],
    "schema": "string"
  },
  "knownAsName": "string",
  "legalName": "string"
}

EPC API for receiving Electrum calls (17.1.0)

credit-transfer

identifier-determination

Schema

PersonIdentification

PartyIdentification

Party

transactional

request-to-pay

financial

bulk

refund