URL
Electrum Support
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:
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.
https://example.com/path/payments/partner-api/v1/
A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
{ "additionalIdentifications": [ { … } ], "address": { "addressLine": [ … ], "addressType": "ADDR", "buildingName": "string", "buildingNumber": "string", "country": "string", "countrySubDivision": "string", "department": "string", "districtName": "string", "floor": "string", "postBox": "string", "postCode": "string", "room": "string", "streetName": "string", "subDepartment": "string", "townLocationName": "string", "townName": "string" }, "bicfi": "string", "branch": { "address": { … }, "identification": "string", "name": "string" }, "clearingSystemMemberId": { "clearingSystem": { … }, "memberId": "string" }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }
ACCC : AcceptedSettlementCompletedCreditorAccountACCP : AcceptedCustomerProfileACSC : AcceptedSettlementCompletedDebtorAccountACTC : AcceptedTechnicalValidationACWP : AcceptedWithoutPostingACSP : AcceptedSettlementInProcessACWC : AcceptedWithChangeAB01 : AbortedClearingTimeoutAB02 : AbortedClearingFatalErrorAB03 : AbortedSettlementTimeoutAB04 : AbortedSettlementFatalErrorAB05 : TimeoutCreditorAgentAB06 : TimeoutInstructedAgentAB07 : OfflineAgentAB08 : OfflineCreditorAgentAB09 : ErrorCreditorAgentAB10 : ErrorInstructedAgentAB11 : TimeoutDebtorAgentAC01 : IncorrectAccountNumberAC02 : InvalidDebtorAccountNumberAC03 : InvalidCreditorAccountNumberAC04 : ClosedAccountNumberAC05 : ClosedDebtorAccountNumberAC06 : BlockedAccountAC07 : ClosedCreditorAccountNumberAC08 : InvalidBranchCodeAC09 : InvalidAccountCurrencyAC10 : InvalidDebtorAccountCurrencyAC11 : InvalidCreditorAccountCurrencyAC12 : InvalidAccountTypeAC13 : InvalidDebtorAccountTypeAC14 : InvalidCreditorAccountTypeAC15 : AccountDetailsChangedAC16 : CardNumberInvalidAC17 : AccountInLiquidationAEXR : AlreadyExpiredRTPAG01 : TransactionForbiddenAG02 : InvalidBankOperationCodeAG03 : TransactionNotSupportedAG04 : InvalidAgentCountryAG05 : InvalidDebtorAgentCountryAG06 : InvalidCreditorAgentCountryAG07 : UnsuccessfulDirectDebitAG08 : InvalidAccessRightsAG09 : PaymentNotReceivedAG10 : AgentSuspendedAG11 : CreditorAgentSuspendedAG12 : NotAllowedBookTransferAG13 : ForbiddenReturnPaymentAGNT : IncorrectAgentALAC : AlreadyAcceptedRTPAM01 : ZeroAmountAM02 : NotAllowedAmountAM03 : NotAllowedCurrencyAM04 : InsufficientFundsAM05 : DuplicationAM06 : TooLowAmountAM07 : BlockedAmountAM09 : WrongAmountAM10 : InvalidControlSumAM11 : InvalidTransactionCurrencyAM12 : InvalidAmountAM13 : AmountExceedsClearingSystemLimitAM14 : AmountExceedsAgreedLimitAM15 : AmountBelowClearingSystemMinimumAM16 : InvalidGroupControlSumAM17 : InvalidPaymentInfoControlSumAM18 : InvalidNumberOfTransactionsAM19 : InvalidGroupNumberOfTransactionsAM20 : InvalidPaymentInfoNumberOfTransactionsAM21 : LimitExceededAM22 : ZeroAmountNotAppliedAM23 : AmountExceedsSettlementLimitAPAR : AlreadyPaidRTPARDT : AlreadyReturnedTransactionARFR : AlreadyRefusedRTPARJR : AlreadyRejectedRTPATNS : AttachmentsNotSupportedBE01 : InconsistentWithEndCustomerBE04 : MissingCreditorAddressBE05 : UnrecognisedInitiatingPartyBE06 : UnknownEndCustomerBE07 : MissingDebtorAddressBE08 : MissingDebtorNameBE09 : InvalidCountryBE10 : InvalidDebtorCountryBE11 : InvalidCreditorCountryBE12 : InvalidCountryOfResidenceBE13 : InvalidDebtorCountryOfResidenceBE14 : InvalidCreditorCountryOfResidenceBE15 : InvalidIdentificationCodeBE16 : InvalidDebtorIdentificationCodeBE17 : InvalidCreditorIdentificationCodeBE18 : InvalidContactDetailsBE19 : InvalidChargeBearerCodeBE20 : InvalidNameLengthBE21 : MissingNameBE22 : MissingCreditorNameBE23 : AccountProxyInvalidCERI : CheckERICH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFutureCH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPastCH07 : ElementIsNotToBeUsedAtB-andC-LevelCH09 : MandateChangesNotAllowedCH10 : InformationOnMandateChangesMissingCH11 : CreditorIdentifierIncorrectCH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-LevelCH13 : OriginalDebtorAccountIsNotToBeUsedCH14 : OriginalDebtorAgentIsNotToBeUsedCH15 : ElementContentIncludesMoreThan140CharactersCH16 : ElementContentFormallyIncorrectCH17 : ElementNotAdmittedCH19 : ValuesWillBeSetToNextTARGETdayCH20 : DecimalPointsNotCompatibleWithCurrencyCH21 : RequiredCompulsoryElementMissingCH22 : COREandB2BwithinOnemessageCHQC : ChequeSettledOnCreditorAccountCN01 : AuthorisationCancelledCNOR : CreditorBankIsNotRegisteredCURR : IncorrectCurrencyCUST : RequestedByCustomerDNOR : DebtorBankIsNotRegisteredDS01 : ElectronicSignaturesCorrectDS02 : OrderCancelledDS03 : OrderNotCancelledDS04 : OrderRejectedDS05 : OrderForwardedForPostprocessingDS06 : TransferOrderDS07 : ProcessingOKDS08 : DecompressionErrorDS09 : DecryptionErrorDS0A : DataSignRequestedDS0B : UnknownDataSignFormatDS0C : SignerCertificateRevokedDS0D : SignerCertificateNotValidDS0E : IncorrectSignerCertificateDS0F : SignerCertificationAuthoritySignerNotValidDS0G : NotAllowedPaymentDS0H : NotAllowedAccountDS0K : NotAllowedNumberOfTransactionDS10 : Signer1CertificateRevokedDS11 : Signer1CertificateNotValidDS12 : IncorrectSigner1CertificateDS13 : SignerCertificationAuthoritySigner1NotValidDS14 : UserDoesNotExistDS15 : IdenticalSignatureFoundDS16 : PublicKeyVersionIncorrectDS17 : DifferentOrderDataInSignaturesDS18 : RepeatOrderDS19 : ElectronicSignatureRightsInsufficientDS20 : Signer2CertificateRevokedDS21 : Signer2CertificateNotValidDS22 : IncorrectSigner2CertificateDS23 : SignerCertificationAuthoritySigner2NotValidDS24 : WaitingTimeExpiredDS25 : OrderFileDeletedDS26 : UserSignedMultipleTimesDS27 : UserNotYetActivatedDT01 : InvalidDateDT02 : InvalidCreationDateDT03 : InvalidNonProcessingDateDT04 : FutureDateNotSupportedDT05 : InvalidCutOffDateDT06 : ExecutionDateChangedDU01 : DuplicateMessageIDDU02 : DuplicatePaymentInformationIDDU03 : DuplicateTransactionDU04 : DuplicateEndToEndIDDU05 : DuplicateInstructionIDDUPL : DuplicatePaymentED01 : CorrespondentBankNotPossibleED03 : BalanceInfoRequestED05 : SettlementFailedED06 : SettlementSystemNotAvailableEDTL : ExpiryDateTooLongEDTR : ExpiryDateTimeReachedERIN : ERIOptionNotSupportedFF01 : InvalidFileFormatFF02 : SyntaxErrorFF03 : InvalidPaymentTypeInformationFF04 : InvalidServiceLevelCodeFF05 : InvalidLocalInstrumentCodeFF06 : InvalidCategoryPurposeCodeFF07 : InvalidPurposeFF08 : InvalidEndToEndIdFF09 : InvalidChequeNumberFF10 : BankSystemProcessingErrorFF11 : ClearingRequestAbortedFF12 : OriginalTransactionNotEligibleForRequestedReturnFF13 : RequestForCancellationNotFoundFOCR : FollowingCancellationRequestFR01 : FraudFRAD : FraudulentOriginG000 : PaymentTransferredAndTrackedG001 : PaymentTransferredAndNotTrackedG002 : CreditDebitNotConfirmedG003 : CreditPendingDocumentsG004 : CreditPendingFundsG005 : DeliveredWithServiceLevelG006 : DeliveredWithoutServiceLevelID01 : CorrespondingOriginalFileStillNotSentIEDT : IncorrectExpiryDateTimeIRNR : InitialRTPNeverReceivedMD01 : NoMandateMD02 : MissingMandatoryInformationInMandateMD05 : CollectionNotDueMD06 : RefundRequestByEndCustomerMD07 : EndCustomerDeceasedMS02 : NotSpecifiedReasonCustomerGeneratedMS03 : NotSpecifiedReasonAgentGeneratedNARR : NarrativeNERI : NoERINOAR : NonAgreedRTPNOAS : NoAnswerFromCustomerNOCM : NotCompliantGenericNOOR : NoOriginalTransactionReceivedNOPG : NoPaymentGuaranteeNRCH : PayerOrPayerRTPSPNotReachablePART : PartiallyAcceptedPINS : TypeOfPaymentInstrumentNotSupportedRC01 : BankIdentifierIncorrectRC02 : InvalidBankIdentifierRC03 : InvalidDebtorBankIdentifierRC04 : InvalidCreditorBankIdentifierRC05 : InvalidBICIdentifierRC06 : InvalidDebtorBICIdentifierRC07 : InvalidCreditorBICIdentifierRC08 : InvalidClearingSystemMemberIdentifierRC09 : InvalidDebtorClearingSystemMemberIdentifierRC10 : InvalidCreditorClearingSystemMemberIdentifierRC11 : InvalidIntermediaryAgentRC12 : MissingCreditorSchemeIdRCON : RMessageConflictRECI : ReceiverCustomerInformationREPR : RTPReceivedCanBeProcessedRF01 : NotUniqueTransactionReferenceRR01 : MissingDebtorAccountOrIdentificationRR02 : MissingDebtorNameOrAddressRR03 : MissingCreditorNameOrAddressRR04 : RegulatoryReasonRR05 : RegulatoryInformationInvalidRR06 : TaxInformationInvalidRR07 : RemittanceInformationInvalidRR08 : RemittanceInformationTruncatedRR09 : InvalidStructuredCreditorReferenceRR10 : InvalidCharacterSetRR11 : InvalidDebtorAgentServiceIDRR12 : InvalidPartyIDRTNS : RTPNotSupportedForDebtorRUTA : ReturnUponUnableToApplyS000 : ValidRequestForCancellationAcknowledgedS001 : UETRFlaggedForCancellationS002 : NetworkStopOfUETRS003 : RequestForCancellationForwardedS004 : RequestForCancellationDeliveryAcknowledgementSL01 : SpecificServiceOfferedByDebtorAgentSL02 : SpecificServiceOfferedByCreditorAgentSL03 : ServiceofClearingSystemSL11 : CreditorNotOnWhitelistOfDebtorSL12 : CreditorOnBlacklistOfDebtorSL13 : MaximumNumberOfDirectDebitTransactionsExceededSL14 : MaximumDirectDebitTransactionAmountExceededSP01 : PaymentStoppedSP02 : PreviouslyStoppedSPII : RTPServiceProviderIdentifierIncorrectTA01 : TransmissionAbortedTD01 : NoDataAvailableTD02 : FileNonReadableTD03 : IncorrectFileStructureTK01 : TokenInvalidTK02 : SenderTokenNotFoundTK03 : ReceiverTokenNotFoundTK09 : TokenMissingTKCM : TokenCounterpartyMismatchTKSG : TokenSingleUseTKSP : TokenSuspendedTKVE : TokenValueLimitExceededTKXP : TokenExpiredTM01 : InvalidCutOffTimeTS01 : TransmissionSuccessfulTS04 : TransferToSignByHandUCRD : UnknownCreditorUPAY : UnduePayment{ "schema": "string", "value": "ACCC" }