EPC API for receiving Electrum calls (15.2.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Download OpenAPI description

bpp-elpapi-partner.json

bpp-elpapi-partner.yaml

Overview

URL https://electrum.co.za

Electrum Support support@electrum.co.za

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-partner/bpp-elpapi-partner/

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

transactional

Operations

request-to-pay

Operations

Response to a prior request to pay or status request

Request

Communicates the status of a prior request to pay initiated by a customer of the partner.

An outboundRequestToPayResponse may indicate that a request to pay, sent to Electrum by the partner on behalf of a partner's customer, will be presented to the debtor, has already been paid or has failed for some reason. A new unsolicited outboundRequestToPayResponse may be received for each status update of the request to pay.

If the partner is unsure of the status of an outboundRequestToPay, an outboundRequestToPayStatusRequest may be used to solicit an up-to-date outboundRequestToPayResponse.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗

Headers

traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

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.

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

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.

Bodyapplication/jsonrequired

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.

originalMessageIdentifiersobject(MessageIdentifiers)required

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

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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

originalRequestToPayDataobject(OriginalRequestToPayData)

Contains key elements related to the original request to pay that is being referred to.

requestToPayConditionsobject(RequestToPayConditions)

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

schemastringrequired

Value"RequestToPayResponse"

statusobject(RequestToPayStatus)required

status.reasonInfoArray of objects(RequestToPayStatusReasonInfo)non-empty

A list of RequestToPayStatusReasonInfo values providing detailed reason information for the status.

status.statusstringrequired

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an intial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

Enum"PAID""ACCEPTED""CANCELLED""EXPIRED""PENDING""PRESENTED""REJECTED""REFUND_IN_PROGRESS""REFUNDED"

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/epc-partner/bpp-elpapi-partner/transactions/outbound/request-to-pay-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "status": {
      "status": "PRESENTED"
    },
    "schema": "RequestToPayResponse",
    "messageIdentifiers": {
      "messageIdentification": "89730ee05e184fb094cf27cec5078d6b",
      "creationDateTime": "2022-05-04T03:02:02Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "requestToPayConditions": {
      "minAmount": {
        "value": 100,
        "currency": "ZAR"
      },
      "maxAmount": {
        "value": 100,
        "currency": "ZAR"
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

The outcome of a prior outboundRequestToPayCancellationRequest operation

Request

Communicates the outcome of a prior outboundRequestToPayCancellationRequest operation.

An outboundRequestToPayCancellationRequest operation is not guaranteed to be successful. For example, if the associated outboundRequestToPay has already been paid then it cannot be cancelled.

Note too that if the associated outboundRequestToPay was rejected or has already expired then the outboundRequestToPayCancellationRequest operation will be deemed to have failed despite the net result of no subsequent payment. This is because the final status of the outboundRequestToPay will be something other than a cancellation.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗