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://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/
https://example.com/path/payments/api/v1/
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/health
https://example.com/path/payments/api/v1/health
curl -i -X GET \
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/health \
-H 'traceparent: string' \
-H 'tracestate: string'OK. RFC9110 - 200
PASS: The service is healthyFAIL: The service is unhealthyWARN: The service is healthy with some concerns{ "status": "PASS" }