Verification

Electrum Regulated Payments Partner API (17.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

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.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

ZaAccountVerificationData

Fields specific to account verification services in South Africa. The fields checksDebitsAllowed, checksCreditsAllowed and checksOlderThanThreeMonths indicate to the receiving FI whether or not to return the associated information (i.e. true or false in respect to those items)

schemastringrequired

Discriminator

checkCreditsAllowedboolean

Sets whether or not the response should indicate if credits are allowed on the account.

checkDebitsAllowedboolean

Sets whether or not the response should indicate if debits are allowed on the account.

checkOlderThanThreeMonthsboolean

Sets whether or not the response should indicate whether the account is older than 3 months.

initialsstring<= 70 characters

Initials of the individual account owner that is to be verified.

lastNamestring<= 70 characters

Family name of the individual account owner that is to be verified.

{
  "schema": "ZA_AVS",
  "checkCreditsAllowed": true,
  "checkDebitsAllowed": true,
  "checkOlderThanThreeMonths": true,
  "initials": "string",
  "lastName": "string"
}

Verification

accountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

account.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

account.identificationobject(BankingIdentifier)

account.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

account.proxyobject(NonBankingIdentifier)

account.typeobject(AccountType)

agentobject(InstitutionIdentification)

identificationstring[ 1 .. 35 ] characters

Uniquely identifies this verification. Used in cases where a list of verifications are necessary, in such cases a verification may need to be uniquely identified independently from other verifications.

partyobject(Party)required

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

party.addressobject(PostalAddress)

party.contactDetailsobject(ContactDetails)

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

party.identificationobject(PartyIdentification)

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

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

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

schemeVerificationDataobject(SchemeVerificationData)

This object contains fields specific to the scheme being interacted with and determined by the chosen schema. Typically these are fields that are not standard within ISO20022 ACMT.023

{
  "account": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "identification": "string",
  "party": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "schemeVerificationData": {
    "schema": "string"
  }
}

AccountVerificationRequest

A model containing the foundational elements shared across messages relating to transactions.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

assigneeobject(Party)required

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

assignee.addressobject(PostalAddress)

assignee.contactDetailsobject(ContactDetails)

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

assignee.identificationobject(PartyIdentification)

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

assignee.knownAsNamestring[ 1 .. 140 ] characters

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

assignerobject(Party)required

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

assigner.addressobject(PostalAddress)

assigner.contactDetailsobject(ContactDetails)

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

assigner.identificationobject(PartyIdentification)

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

assigner.knownAsNamestring[ 1 .. 140 ] characters

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

creatorobject(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.

firstAgentobject(InstitutionIdentification)

schemastringrequired

Value"AccountVerificationRequest"

verificationobject(Verification)required

verification.accountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

verification.account.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

verification.account.identificationobject(BankingIdentifier)

verification.account.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

verification.account.proxyobject(NonBankingIdentifier)

verification.account.typeobject(AccountType)

verification.agentobject(InstitutionIdentification)

verification.identificationstring[ 1 .. 35 ] characters

verification.partyobject(Party)required

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

verification.party.addressobject(PostalAddress)

verification.party.contactDetailsobject(ContactDetails)

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

verification.party.identificationobject(PartyIdentification)

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

verification.party.knownAsNamestring[ 1 .. 140 ] characters

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

verification.schemeVerificationDataobject(SchemeVerificationData)

This object contains fields specific to the scheme being interacted with and determined by the chosen schema. Typically these are fields that are not standard within ISO20022 ACMT.023

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "assignee": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "assigner": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "firstAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "schema": "AccountVerificationRequest",
  "verification": {
    "account": { … },
    "agent": { … },
    "identification": "string",
    "party": { … },
    "schemeVerificationData": { … }
  }
}

Electrum Regulated Payments Partner API (17.1.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

Schema

ZaAccountVerificationData

Verification

AccountVerificationRequest

operational

bulk

request-to-pay

refund

account-verification