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/
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.{ "schema": "string", "value": "ARNU" }