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.
https://example.com/path/payments/api/v1/
Provides details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
{ "dateOfSignature": "2019-08-24", "electronicSignature": "string", "finalCollectionDate": "2019-08-24", "firstCollectionDate": "2019-08-24", "frequency": { "dayOfMonth": 1, "schema": "MonthlyFrequency" }, "mandateIdentification": "string", "reason": { "schema": "string", "value": "stri" }, "trackingDays": 1 }
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
{ "currency": "string", "value": 0.1 }