Electrum Regulated Payments API (21.0.2)

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:

  • Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in this document.
  • 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 the Electrum Regulated Payments Partner API.

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.

Download OpenAPI description
Overview
Languages
Servers
Payments API sandbox

https://example.com/path/payments/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

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

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

Operations

refund

Operations related to the refund of a prior successful financial transaction.

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

CancellationReasonCode

schemastring

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

valuestring

AC02 InvalidDebtorAccountNumber - Debtor account number invalid or missing. AC03 InvalidCreditorAccountNumber - Wrong account number in Credit Transfer. AGNT IncorrectAgent - Agent in the payment workflow is incorrect. AM09 WrongAmount - Amount is not the amount agreed or expected. BE16 InvalidDebtorIdentificationCode - Debtor or Ultimate Debtor identification code missing or invalid. COVR CoverCancelledOrReturned - Cover payments has either been returned or cancelled. CURR IncorrectCurrency - Currency of the payment is incorrect. CUST RequestedByCustomer - Cancellation requested by the Debtor. CUTA CancelUponUnableToApply - Cancellation requested because an investigation request has been received and no remediation is possible. DS24 TimeOut - Cancellation requested because the original payment order expired due to time-out. DT01 InvalidDate - Invalid date (for example, wrong or missing settlement date). DUPL DuplicatePayment - Payment is a duplicate of another payment. FRAD FraudulentOrigin - Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions. FRNA ForwardToNextAgent - To complement a rejection response, suggesting the request for cancelation should be forwarded to the next agent in the payment transaction chain. FRTR FinalResponse - Direct Debit Tracking recalled as Mandate Cancelled INDM IndemnityRequired - To express the wish to establish a bilateral indemnity agreement. MODT ModifiedTransaction - The underlying transaction in relation to an RTP was modified. PAID TransactionAlreadyPaid - The underlying transaction in relation to an RTP was already paid (via other means). SVNR ServiceNotRendered - The payment is cancelled since a cash amount rendered was not correct or goods or a service was not rendered to the customer, e.g. in an e-commerce situation. SYAD RequestToSettlementSystemAdministrator - Cancellation requested by System Member to Settlement System Administrator to indicate that the cancellation request must not be forwarded further in the chain. TECH TechnicalProblem - Cancellation requested following technical problems resulting in an erroneous transaction. UPAY UnduePayment - Payment is not justified. ENUE EndUserError - Cancellation or request for return requested by the Debtor specifically due to one or more errors by debtor in the original Credit Transfer. Usage: This code can be used for any error in the original Credit Transfer made by the Debtor. Can also be used if multiple errors were made in the original Credit Transfer. UAPA UnauthorizedPayment - "The Debtor is requesting a return of the payment because the payment was not properly authorized. Usage: This code can be used in the case where a Credit Transfer was made without proper authorization from the Debtor. This could be due to compromised end user credentials." NARR Narrative - Reason is provided as narrative information in the additional reason information. INCR InvalidCancellationRequest - Process a cancellation request with incorrect reference to original batch. BIAS BatchInstructionAlreadySettled - Process a cancellation request but batch already settled. DRTP DuplicationRequestToPay - Duplication of a request-to-pay message. WNTB WarrantyBreach - Breach of warranty provided in connection with a request for payment. MD06 RefundRequestByEndCustomer - Return of funds requested by end customer. PPRC PayeeParticipantRTPCancellation - Request to Pay cancellation initiated because the Payee is not in good standing. ECAG ErrorCreditorAgent - Payee (Creditor) cancels the Request To Pay (RTP) request due to error or adjustment agreement with Payer/Debtor. NFNA NeverForwardToNextAgent - To complement a cancellation request, instructing the market infrastructure that the request for cancelation should not be forwarded to the next agent in the payment transaction chain.

Enum"AC02""AC03""AGNT""AM09""BE16""COVR""CURR""CUST""CUTA""DS24"
{ "schema": "string", "value": "AC02" }

CancellationReason

Specifies the reason for a payment cancellation

schemastring

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

Discriminator
valuestring

AC02 InvalidDebtorAccountNumber - Debtor account number invalid or missing. AC03 InvalidCreditorAccountNumber - Wrong account number in Credit Transfer. AGNT IncorrectAgent - Agent in the payment workflow is incorrect. AM09 WrongAmount - Amount is not the amount agreed or expected. BE16 InvalidDebtorIdentificationCode - Debtor or Ultimate Debtor identification code missing or invalid. COVR CoverCancelledOrReturned - Cover payments has either been returned or cancelled. CURR IncorrectCurrency - Currency of the payment is incorrect. CUST RequestedByCustomer - Cancellation requested by the Debtor. CUTA CancelUponUnableToApply - Cancellation requested because an investigation request has been received and no remediation is possible. DS24 TimeOut - Cancellation requested because the original payment order expired due to time-out. DT01 InvalidDate - Invalid date (for example, wrong or missing settlement date). DUPL DuplicatePayment - Payment is a duplicate of another payment. FRAD FraudulentOrigin - Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions. FRNA ForwardToNextAgent - To complement a rejection response, suggesting the request for cancelation should be forwarded to the next agent in the payment transaction chain. FRTR FinalResponse - Direct Debit Tracking recalled as Mandate Cancelled INDM IndemnityRequired - To express the wish to establish a bilateral indemnity agreement. MODT ModifiedTransaction - The underlying transaction in relation to an RTP was modified. PAID TransactionAlreadyPaid - The underlying transaction in relation to an RTP was already paid (via other means). SVNR ServiceNotRendered - The payment is cancelled since a cash amount rendered was not correct or goods or a service was not rendered to the customer, e.g. in an e-commerce situation. SYAD RequestToSettlementSystemAdministrator - Cancellation requested by System Member to Settlement System Administrator to indicate that the cancellation request must not be forwarded further in the chain. TECH TechnicalProblem - Cancellation requested following technical problems resulting in an erroneous transaction. UPAY UnduePayment - Payment is not justified. ENUE EndUserError - Cancellation or request for return requested by the Debtor specifically due to one or more errors by debtor in the original Credit Transfer. Usage: This code can be used for any error in the original Credit Transfer made by the Debtor. Can also be used if multiple errors were made in the original Credit Transfer. UAPA UnauthorizedPayment - "The Debtor is requesting a return of the payment because the payment was not properly authorized. Usage: This code can be used in the case where a Credit Transfer was made without proper authorization from the Debtor. This could be due to compromised end user credentials." NARR Narrative - Reason is provided as narrative information in the additional reason information. INCR InvalidCancellationRequest - Process a cancellation request with incorrect reference to original batch. BIAS BatchInstructionAlreadySettled - Process a cancellation request but batch already settled. DRTP DuplicationRequestToPay - Duplication of a request-to-pay message. WNTB WarrantyBreach - Breach of warranty provided in connection with a request for payment. MD06 RefundRequestByEndCustomer - Return of funds requested by end customer. PPRC PayeeParticipantRTPCancellation - Request to Pay cancellation initiated because the Payee is not in good standing. ECAG ErrorCreditorAgent - Payee (Creditor) cancels the Request To Pay (RTP) request due to error or adjustment agreement with Payer/Debtor. NFNA NeverForwardToNextAgent - To complement a cancellation request, instructing the market infrastructure that the request for cancelation should not be forwarded to the next agent in the payment transaction chain.

Enum"AC02""AC03""AGNT""AM09""BE16""COVR""CURR""CUST""CUTA""DS24"
{ "schema": "CODE", "value": "AC02" }

CancellationReasonInfo

additionalInformationArray of strings

Additional information about the reason.

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(CancellationReason)

Specifies the reason for a payment cancellation

{ "additionalInformation": [ "string" ], "originator": { "address": {}, "contactDetails": {}, "countryOfResidence": "string", "identification": {}, "knownAsName": "string", "legalName": "string" }, "reason": { "schema": "string", "value": "AC02" } }

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations