Unique identification, as assigned by an organisation, to unambiguously identify a party
{ "registrationIdentification": "string", "taxIdentification": "string", "taxType": "string", "authorisation": { "name": "string", "title": "string" } }
The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.
This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.
As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.
All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-events/
https://example.com/path/payments/events-api/v1/
Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.
Tax reference information that is specific to a taxing agency.
{ "creditor": { "registrationIdentification": "string", "taxIdentification": "string", "taxType": "string" }, "date": "2019-08-24", "debtor": { "registrationIdentification": "string", "taxIdentification": "string", "taxType": "string", "authorisation": { … } }, "referenceNumber": "string", "sequenceNumber": 0, "totalTaxAmount": { "currency": "string", "value": 0.1 }, "totalTaxableBaseAmount": { "currency": "string", "value": 0.1 }, "ultimateDebtor": { "registrationIdentification": "string", "taxIdentification": "string", "taxType": "string", "authorisation": { … } } }
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.
{ "additionalRemittanceInformation": [ "string" ], "creditorReference": { "reference": "string", "type": { … } }, "invoicer": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "originatorReference": "string", "referredDocumentAmount": { "duePayableAmount": { … }, "remittedAmount": { … } }, "referredDocuments": [ { … } ], "taxRemittance": { "creditor": { … }, "date": "2019-08-24", "debtor": { … }, "referenceNumber": "string", "sequenceNumber": 0, "totalTaxAmount": { … }, "totalTaxableBaseAmount": { … }, "ultimateDebtor": { … } } }