Electrum Regulated Payments Partner API (21.0.2)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

  • Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
  • Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

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.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

Download OpenAPI description
Languages
Servers
Partner API sandbox

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

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

Schema

CancellationStatusReason

schemastring

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
valuestring

AC04 ClosedAccountNumber - Account number specified has been closed on the receiver’s books. ADAC AwaitingDebitAuthorityFromCustomer - Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account. AGNT AgentDecision - Reported when the cancellation cannot be accepted because of an agent refuses to cancel. AM04 InsufficientFunds - Amount of funds available to cover specified message amount is insufficient. ARDT AlreadyReturned - Cancellation not accepted as the transaction has already been returned. ARPL AwaitinReply - Reported when the cancellation request cannot be processed because no reply has been  received yet from the receiver of the request message. CUST CustomerDecision - Reported when the cancellation cannot be accepted because of a customer decision (Creditor). LEGL LegalDecision - Reported when the cancellation cannot be accepted because of regulatory rules. NARR Narrative - Reason is provided as narrative information in the additional reason information. NOAS NoAnswerFromCustomer - No response from beneficiary (to the cancellation request). NOOR NoOriginalTransactionReceived - Original transaction (subject to cancellation) never received. PTNA PassedToTheNextAgent - Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent. RQDA RequestingDebitAuthority - Reported when authority is required by the Creditor to return the payment. WSEQ WrongSequence - Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid. INDM CancellationIndemnityRequired - Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established. ACLR AlreadyCancelledRTP - Request-to-pay has already been cancelled. AEXR AlreadyExpiredRTP - Request-to-pay Expiry Date and Time has already passed. ARFR AlreadyRefusedRTP - Request-to-pay has already been refused by the Debtor. ARJR AlreadyRejectedRTP - Request-to-pay has already been rejected. PATE PaymentAlreadyTransmittedExecution - Payment related to the request-to-pay has already been transmitted for execution. RR04 RegulatoryReason - Regulatory Reason. RCAR RfCAlreadyRejected - Request for cancellation of the request-to-pay has already been rejected. RCNR RfCNeverReceived - Request for cancellation of the request-to-pay has never been received. RCPR RfCReceivedAndProcessed - Request for cancellation of the request-to-pay has already been received and processed. URTP UnknownRTP - Request-to-pay is unknown. AACR AlreadyAcceptedRTP - Request-to-pay (RTP) has already been accepted.

Enum"AC04""ADAC""AGNT""AM04""ARDT""ARPL""CUST""LEGL""NARR""NOAS"
{ "schema": "CODE", "value": "AC04" }

CancellationStatusReasonInformation

originatorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

reasonobject(CancellationStatusReason)
{ "originator": { "address": {}, "contactDetails": {}, "countryOfResidence": "string", "identification": {}, "knownAsName": "string", "legalName": "string" }, "reason": { "schema": "string", "value": "AC04" } }

CancellationStatusCode

RJCR RejectedCancellationRequest - Cancellation request is rejected ACCR AcceptedCancellationRequest - Cancellation is accepted. PDCR PendingCancellationRequest - Cancellation request is pending.

string(CancellationStatusCode)

RJCR RejectedCancellationRequest - Cancellation request is rejected ACCR AcceptedCancellationRequest - Cancellation is accepted. PDCR PendingCancellationRequest - Cancellation request is pending.

Enum"RJCR""ACCR""PDCR"
"RJCR"

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations