Electrum Regulated Payments Partner API (17.1.0)

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

elpapi-partner.json

elpapi-partner.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

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

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

Schema

StatusReasonType

schemastringrequired

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

Discriminator

valuestringrequired

ACCC : AcceptedSettlementCompletedCreditorAccount
ACCP : AcceptedCustomerProfile
ACSC : AcceptedSettlementCompletedDebtorAccount
ACTC : AcceptedTechnicalValidation
ACWP : AcceptedWithoutPosting
ACSP : AcceptedSettlementInProcess
ACWC : AcceptedWithChange
AB01 : AbortedClearingTimeout
AB02 : AbortedClearingFatalError
AB03 : AbortedSettlementTimeout
AB04 : AbortedSettlementFatalError
AB05 : TimeoutCreditorAgent
AB06 : TimeoutInstructedAgent
AB07 : OfflineAgent
AB08 : OfflineCreditorAgent
AB09 : ErrorCreditorAgent
AB10 : ErrorInstructedAgent
AB11 : TimeoutDebtorAgent
AC01 : IncorrectAccountNumber
AC02 : InvalidDebtorAccountNumber
AC03 : InvalidCreditorAccountNumber
AC04 : ClosedAccountNumber
AC05 : ClosedDebtorAccountNumber
AC06 : BlockedAccount
AC07 : ClosedCreditorAccountNumber
AC08 : InvalidBranchCode
AC09 : InvalidAccountCurrency
AC10 : InvalidDebtorAccountCurrency
AC11 : InvalidCreditorAccountCurrency
AC12 : InvalidAccountType
AC13 : InvalidDebtorAccountType
AC14 : InvalidCreditorAccountType
AC15 : AccountDetailsChanged
AC16 : CardNumberInvalid
AC17 : AccountInLiquidation
AEXR : AlreadyExpiredRTP
AG01 : TransactionForbidden
AG02 : InvalidBankOperationCode
AG03 : TransactionNotSupported
AG04 : InvalidAgentCountry
AG05 : InvalidDebtorAgentCountry
AG06 : InvalidCreditorAgentCountry
AG07 : UnsuccessfulDirectDebit
AG08 : InvalidAccessRights
AG09 : PaymentNotReceived
AG10 : AgentSuspended
AG11 : CreditorAgentSuspended
AG12 : NotAllowedBookTransfer
AG13 : ForbiddenReturnPayment
AGNT : IncorrectAgent
ALAC : AlreadyAcceptedRTP
AM01 : ZeroAmount
AM02 : NotAllowedAmount
AM03 : NotAllowedCurrency
AM04 : InsufficientFunds
AM05 : Duplication
AM06 : TooLowAmount
AM07 : BlockedAmount
AM09 : WrongAmount
AM10 : InvalidControlSum
AM11 : InvalidTransactionCurrency
AM12 : InvalidAmount
AM13 : AmountExceedsClearingSystemLimit
AM14 : AmountExceedsAgreedLimit
AM15 : AmountBelowClearingSystemMinimum
AM16 : InvalidGroupControlSum
AM17 : InvalidPaymentInfoControlSum
AM18 : InvalidNumberOfTransactions
AM19 : InvalidGroupNumberOfTransactions
AM20 : InvalidPaymentInfoNumberOfTransactions
AM21 : LimitExceeded
AM22 : ZeroAmountNotApplied
AM23 : AmountExceedsSettlementLimit
APAR : AlreadyPaidRTP
ARDT : AlreadyReturnedTransaction
ARFR : AlreadyRefusedRTP
ARJR : AlreadyRejectedRTP
ATNS : AttachmentsNotSupported
BE01 : InconsistentWithEndCustomer
BE04 : MissingCreditorAddress
BE05 : UnrecognisedInitiatingParty
BE06 : UnknownEndCustomer
BE07 : MissingDebtorAddress
BE08 : MissingDebtorName
BE09 : InvalidCountry
BE10 : InvalidDebtorCountry
BE11 : InvalidCreditorCountry
BE12 : InvalidCountryOfResidence
BE13 : InvalidDebtorCountryOfResidence
BE14 : InvalidCreditorCountryOfResidence
BE15 : InvalidIdentificationCode
BE16 : InvalidDebtorIdentificationCode
BE17 : InvalidCreditorIdentificationCode
BE18 : InvalidContactDetails
BE19 : InvalidChargeBearerCode
BE20 : InvalidNameLength
BE21 : MissingName
BE22 : MissingCreditorName
BE23 : AccountProxyInvalid
CERI : CheckERI
CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
CH07 : ElementIsNotToBeUsedAtB-andC-Level
CH09 : MandateChangesNotAllowed
CH10 : InformationOnMandateChangesMissing
CH11 : CreditorIdentifierIncorrect
CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
CH13 : OriginalDebtorAccountIsNotToBeUsed
CH14 : OriginalDebtorAgentIsNotToBeUsed
CH15 : ElementContentIncludesMoreThan140Characters
CH16 : ElementContentFormallyIncorrect
CH17 : ElementNotAdmitted
CH19 : ValuesWillBeSetToNextTARGETday
CH20 : DecimalPointsNotCompatibleWithCurrency
CH21 : RequiredCompulsoryElementMissing
CH22 : COREandB2BwithinOnemessage
CHQC : ChequeSettledOnCreditorAccount
CN01 : AuthorisationCancelled
CNOR : CreditorBankIsNotRegistered
CURR : IncorrectCurrency
CUST : RequestedByCustomer
DNOR : DebtorBankIsNotRegistered
DS01 : ElectronicSignaturesCorrect
DS02 : OrderCancelled
DS03 : OrderNotCancelled
DS04 : OrderRejected
DS05 : OrderForwardedForPostprocessing
DS06 : TransferOrder
DS07 : ProcessingOK
DS08 : DecompressionError
DS09 : DecryptionError
DS0A : DataSignRequested
DS0B : UnknownDataSignFormat
DS0C : SignerCertificateRevoked
DS0D : SignerCertificateNotValid
DS0E : IncorrectSignerCertificate
DS0F : SignerCertificationAuthoritySignerNotValid
DS0G : NotAllowedPayment
DS0H : NotAllowedAccount
DS0K : NotAllowedNumberOfTransaction
DS10 : Signer1CertificateRevoked
DS11 : Signer1CertificateNotValid
DS12 : IncorrectSigner1Certificate
DS13 : SignerCertificationAuthoritySigner1NotValid
DS14 : UserDoesNotExist
DS15 : IdenticalSignatureFound
DS16 : PublicKeyVersionIncorrect
DS17 : DifferentOrderDataInSignatures
DS18 : RepeatOrder
DS19 : ElectronicSignatureRightsInsufficient
DS20 : Signer2CertificateRevoked
DS21 : Signer2CertificateNotValid
DS22 : IncorrectSigner2Certificate
DS23 : SignerCertificationAuthoritySigner2NotValid
DS24 : WaitingTimeExpired
DS25 : OrderFileDeleted
DS26 : UserSignedMultipleTimes
DS27 : UserNotYetActivated
DT01 : InvalidDate
DT02 : InvalidCreationDate
DT03 : InvalidNonProcessingDate
DT04 : FutureDateNotSupported
DT05 : InvalidCutOffDate
DT06 : ExecutionDateChanged
DU01 : DuplicateMessageID
DU02 : DuplicatePaymentInformationID
DU03 : DuplicateTransaction
DU04 : DuplicateEndToEndID
DU05 : DuplicateInstructionID
DUPL : DuplicatePayment
ED01 : CorrespondentBankNotPossible
ED03 : BalanceInfoRequest
ED05 : SettlementFailed
ED06 : SettlementSystemNotAvailable
EDTL : ExpiryDateTooLong
EDTR : ExpiryDateTimeReached
ERIN : ERIOptionNotSupported
FF01 : InvalidFileFormat
FF02 : SyntaxError
FF03 : InvalidPaymentTypeInformation
FF04 : InvalidServiceLevelCode
FF05 : InvalidLocalInstrumentCode
FF06 : InvalidCategoryPurposeCode
FF07 : InvalidPurpose
FF08 : InvalidEndToEndId
FF09 : InvalidChequeNumber
FF10 : BankSystemProcessingError
FF11 : ClearingRequestAborted
FF12 : OriginalTransactionNotEligibleForRequestedReturn
FF13 : RequestForCancellationNotFound
FOCR : FollowingCancellationRequest
FR01 : Fraud
FRAD : FraudulentOrigin
G000 : PaymentTransferredAndTracked
G001 : PaymentTransferredAndNotTracked
G002 : CreditDebitNotConfirmed
G003 : CreditPendingDocuments
G004 : CreditPendingFunds
G005 : DeliveredWithServiceLevel
G006 : DeliveredWithoutServiceLevel
ID01 : CorrespondingOriginalFileStillNotSent
IEDT : IncorrectExpiryDateTime
IRNR : InitialRTPNeverReceived
MD01 : NoMandate
MD02 : MissingMandatoryInformationInMandate
MD05 : CollectionNotDue
MD06 : RefundRequestByEndCustomer
MD07 : EndCustomerDeceased
MS02 : NotSpecifiedReasonCustomerGenerated
MS03 : NotSpecifiedReasonAgentGenerated
NARR : Narrative
NERI : NoERI
NOAR : NonAgreedRTP
NOAS : NoAnswerFromCustomer
NOCM : NotCompliantGeneric
NOOR : NoOriginalTransactionReceived
NOPG : NoPaymentGuarantee
NRCH : PayerOrPayerRTPSPNotReachable
PART : PartiallyAccepted
PINS : TypeOfPaymentInstrumentNotSupported
RC01 : BankIdentifierIncorrect
RC02 : InvalidBankIdentifier
RC03 : InvalidDebtorBankIdentifier
RC04 : InvalidCreditorBankIdentifier
RC05 : InvalidBICIdentifier
RC06 : InvalidDebtorBICIdentifier
RC07 : InvalidCreditorBICIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RC09 : InvalidDebtorClearingSystemMemberIdentifier
RC10 : InvalidCreditorClearingSystemMemberIdentifier
RC11 : InvalidIntermediaryAgent
RC12 : MissingCreditorSchemeId
RCON : RMessageConflict
RECI : ReceiverCustomerInformation
REPR : RTPReceivedCanBeProcessed
RF01 : NotUniqueTransactionReference
RR01 : MissingDebtorAccountOrIdentification
RR02 : MissingDebtorNameOrAddress
RR03 : MissingCreditorNameOrAddress
RR04 : RegulatoryReason
RR05 : RegulatoryInformationInvalid
RR06 : TaxInformationInvalid
RR07 : RemittanceInformationInvalid
RR08 : RemittanceInformationTruncated
RR09 : InvalidStructuredCreditorReference
RR10 : InvalidCharacterSet
RR11 : InvalidDebtorAgentServiceID
RR12 : InvalidPartyID
RTNS : RTPNotSupportedForDebtor
RUTA : ReturnUponUnableToApply
S000 : ValidRequestForCancellationAcknowledged
S001 : UETRFlaggedForCancellation
S002 : NetworkStopOfUETR
S003 : RequestForCancellationForwarded
S004 : RequestForCancellationDeliveryAcknowledgement
SL01 : SpecificServiceOfferedByDebtorAgent
SL02 : SpecificServiceOfferedByCreditorAgent
SL03 : ServiceofClearingSystem
SL11 : CreditorNotOnWhitelistOfDebtor
SL12 : CreditorOnBlacklistOfDebtor
SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
SL14 : MaximumDirectDebitTransactionAmountExceeded
SP01 : PaymentStopped
SP02 : PreviouslyStopped
SPII : RTPServiceProviderIdentifierIncorrect
TA01 : TransmissionAborted
TD01 : NoDataAvailable
TD02 : FileNonReadable
TD03 : IncorrectFileStructure
TK01 : TokenInvalid
TK02 : SenderTokenNotFound
TK03 : ReceiverTokenNotFound
TK09 : TokenMissing
TKCM : TokenCounterpartyMismatch
TKSG : TokenSingleUse
TKSP : TokenSuspended
TKVE : TokenValueLimitExceeded
TKXP : TokenExpired
TM01 : InvalidCutOffTime
TS01 : TransmissionSuccessful
TS04 : TransferToSignByHand
UCRD : UnknownCreditor
UPAY : UnduePayment

Enum"ACCC""ACCP""ACSC""ACTC""ACWP""ACSP""ACWC""AB01""AB02""AB03"

{
  "schema": "CODE",
  "value": "ACCC"
}

StatusReasonInfo

Provides detailed information on a status reason.

additionalInformationstring

A human friendly description of the status reason including any further details if applicable.

reasonobject(StatusReasonType)required

reason.schemastringrequired

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

Discriminator

reason.valuestringrequired

ACCC : AcceptedSettlementCompletedCreditorAccount
ACCP : AcceptedCustomerProfile
ACSC : AcceptedSettlementCompletedDebtorAccount
ACTC : AcceptedTechnicalValidation
ACWP : AcceptedWithoutPosting
ACSP : AcceptedSettlementInProcess
ACWC : AcceptedWithChange
AB01 : AbortedClearingTimeout
AB02 : AbortedClearingFatalError
AB03 : AbortedSettlementTimeout
AB04 : AbortedSettlementFatalError
AB05 : TimeoutCreditorAgent
AB06 : TimeoutInstructedAgent
AB07 : OfflineAgent
AB08 : OfflineCreditorAgent
AB09 : ErrorCreditorAgent
AB10 : ErrorInstructedAgent
AB11 : TimeoutDebtorAgent
AC01 : IncorrectAccountNumber
AC02 : InvalidDebtorAccountNumber
AC03 : InvalidCreditorAccountNumber
AC04 : ClosedAccountNumber
AC05 : ClosedDebtorAccountNumber
AC06 : BlockedAccount
AC07 : ClosedCreditorAccountNumber
AC08 : InvalidBranchCode
AC09 : InvalidAccountCurrency
AC10 : InvalidDebtorAccountCurrency
AC11 : InvalidCreditorAccountCurrency
AC12 : InvalidAccountType
AC13 : InvalidDebtorAccountType
AC14 : InvalidCreditorAccountType
AC15 : AccountDetailsChanged
AC16 : CardNumberInvalid
AC17 : AccountInLiquidation
AEXR : AlreadyExpiredRTP
AG01 : TransactionForbidden
AG02 : InvalidBankOperationCode
AG03 : TransactionNotSupported
AG04 : InvalidAgentCountry
AG05 : InvalidDebtorAgentCountry
AG06 : InvalidCreditorAgentCountry
AG07 : UnsuccessfulDirectDebit
AG08 : InvalidAccessRights
AG09 : PaymentNotReceived
AG10 : AgentSuspended
AG11 : CreditorAgentSuspended
AG12 : NotAllowedBookTransfer
AG13 : ForbiddenReturnPayment
AGNT : IncorrectAgent
ALAC : AlreadyAcceptedRTP
AM01 : ZeroAmount
AM02 : NotAllowedAmount
AM03 : NotAllowedCurrency
AM04 : InsufficientFunds
AM05 : Duplication
AM06 : TooLowAmount
AM07 : BlockedAmount
AM09 : WrongAmount
AM10 : InvalidControlSum
AM11 : InvalidTransactionCurrency
AM12 : InvalidAmount
AM13 : AmountExceedsClearingSystemLimit
AM14 : AmountExceedsAgreedLimit
AM15 : AmountBelowClearingSystemMinimum
AM16 : InvalidGroupControlSum
AM17 : InvalidPaymentInfoControlSum
AM18 : InvalidNumberOfTransactions
AM19 : InvalidGroupNumberOfTransactions
AM20 : InvalidPaymentInfoNumberOfTransactions
AM21 : LimitExceeded
AM22 : ZeroAmountNotApplied
AM23 : AmountExceedsSettlementLimit
APAR : AlreadyPaidRTP
ARDT : AlreadyReturnedTransaction
ARFR : AlreadyRefusedRTP
ARJR : AlreadyRejectedRTP
ATNS : AttachmentsNotSupported
BE01 : InconsistentWithEndCustomer
BE04 : MissingCreditorAddress
BE05 : UnrecognisedInitiatingParty
BE06 : UnknownEndCustomer
BE07 : MissingDebtorAddress
BE08 : MissingDebtorName
BE09 : InvalidCountry
BE10 : InvalidDebtorCountry
BE11 : InvalidCreditorCountry
BE12 : InvalidCountryOfResidence
BE13 : InvalidDebtorCountryOfResidence
BE14 : InvalidCreditorCountryOfResidence
BE15 : InvalidIdentificationCode
BE16 : InvalidDebtorIdentificationCode
BE17 : InvalidCreditorIdentificationCode
BE18 : InvalidContactDetails
BE19 : InvalidChargeBearerCode
BE20 : InvalidNameLength
BE21 : MissingName
BE22 : MissingCreditorName
BE23 : AccountProxyInvalid
CERI : CheckERI
CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
CH07 : ElementIsNotToBeUsedAtB-andC-Level
CH09 : MandateChangesNotAllowed
CH10 : InformationOnMandateChangesMissing
CH11 : CreditorIdentifierIncorrect
CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
CH13 : OriginalDebtorAccountIsNotToBeUsed
CH14 : OriginalDebtorAgentIsNotToBeUsed
CH15 : ElementContentIncludesMoreThan140Characters
CH16 : ElementContentFormallyIncorrect
CH17 : ElementNotAdmitted
CH19 : ValuesWillBeSetToNextTARGETday
CH20 : DecimalPointsNotCompatibleWithCurrency
CH21 : RequiredCompulsoryElementMissing
CH22 : COREandB2BwithinOnemessage
CHQC : ChequeSettledOnCreditorAccount
CN01 : AuthorisationCancelled
CNOR : CreditorBankIsNotRegistered
CURR : IncorrectCurrency
CUST : RequestedByCustomer
DNOR : DebtorBankIsNotRegistered
DS01 : ElectronicSignaturesCorrect
DS02 : OrderCancelled
DS03 : OrderNotCancelled
DS04 : OrderRejected
DS05 : OrderForwardedForPostprocessing
DS06 : TransferOrder
DS07 : ProcessingOK
DS08 : DecompressionError
DS09 : DecryptionError
DS0A : DataSignRequested
DS0B : UnknownDataSignFormat
DS0C : SignerCertificateRevoked
DS0D : SignerCertificateNotValid
DS0E : IncorrectSignerCertificate
DS0F : SignerCertificationAuthoritySignerNotValid
DS0G : NotAllowedPayment
DS0H : NotAllowedAccount
DS0K : NotAllowedNumberOfTransaction
DS10 : Signer1CertificateRevoked
DS11 : Signer1CertificateNotValid
DS12 : IncorrectSigner1Certificate
DS13 : SignerCertificationAuthoritySigner1NotValid
DS14 : UserDoesNotExist
DS15 : IdenticalSignatureFound
DS16 : PublicKeyVersionIncorrect
DS17 : DifferentOrderDataInSignatures
DS18 : RepeatOrder
DS19 : ElectronicSignatureRightsInsufficient
DS20 : Signer2CertificateRevoked
DS21 : Signer2CertificateNotValid
DS22 : IncorrectSigner2Certificate
DS23 : SignerCertificationAuthoritySigner2NotValid
DS24 : WaitingTimeExpired
DS25 : OrderFileDeleted
DS26 : UserSignedMultipleTimes
DS27 : UserNotYetActivated
DT01 : InvalidDate
DT02 : InvalidCreationDate
DT03 : InvalidNonProcessingDate
DT04 : FutureDateNotSupported
DT05 : InvalidCutOffDate
DT06 : ExecutionDateChanged
DU01 : DuplicateMessageID
DU02 : DuplicatePaymentInformationID
DU03 : DuplicateTransaction
DU04 : DuplicateEndToEndID
DU05 : DuplicateInstructionID
DUPL : DuplicatePayment
ED01 : CorrespondentBankNotPossible
ED03 : BalanceInfoRequest
ED05 : SettlementFailed
ED06 : SettlementSystemNotAvailable
EDTL : ExpiryDateTooLong
EDTR : ExpiryDateTimeReached
ERIN : ERIOptionNotSupported
FF01 : InvalidFileFormat
FF02 : SyntaxError
FF03 : InvalidPaymentTypeInformation
FF04 : InvalidServiceLevelCode
FF05 : InvalidLocalInstrumentCode
FF06 : InvalidCategoryPurposeCode
FF07 : InvalidPurpose
FF08 : InvalidEndToEndId
FF09 : InvalidChequeNumber
FF10 : BankSystemProcessingError
FF11 : ClearingRequestAborted
FF12 : OriginalTransactionNotEligibleForRequestedReturn
FF13 : RequestForCancellationNotFound
FOCR : FollowingCancellationRequest
FR01 : Fraud
FRAD : FraudulentOrigin
G000 : PaymentTransferredAndTracked
G001 : PaymentTransferredAndNotTracked
G002 : CreditDebitNotConfirmed
G003 : CreditPendingDocuments
G004 : CreditPendingFunds
G005 : DeliveredWithServiceLevel
G006 : DeliveredWithoutServiceLevel
ID01 : CorrespondingOriginalFileStillNotSent
IEDT : IncorrectExpiryDateTime
IRNR : InitialRTPNeverReceived
MD01 : NoMandate
MD02 : MissingMandatoryInformationInMandate
MD05 : CollectionNotDue
MD06 : RefundRequestByEndCustomer
MD07 : EndCustomerDeceased
MS02 : NotSpecifiedReasonCustomerGenerated
MS03 : NotSpecifiedReasonAgentGenerated
NARR : Narrative
NERI : NoERI
NOAR : NonAgreedRTP
NOAS : NoAnswerFromCustomer
NOCM : NotCompliantGeneric
NOOR : NoOriginalTransactionReceived
NOPG : NoPaymentGuarantee
NRCH : PayerOrPayerRTPSPNotReachable
PART : PartiallyAccepted
PINS : TypeOfPaymentInstrumentNotSupported
RC01 : BankIdentifierIncorrect
RC02 : InvalidBankIdentifier
RC03 : InvalidDebtorBankIdentifier
RC04 : InvalidCreditorBankIdentifier
RC05 : InvalidBICIdentifier
RC06 : InvalidDebtorBICIdentifier
RC07 : InvalidCreditorBICIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RC09 : InvalidDebtorClearingSystemMemberIdentifier
RC10 : InvalidCreditorClearingSystemMemberIdentifier
RC11 : InvalidIntermediaryAgent
RC12 : MissingCreditorSchemeId
RCON : RMessageConflict
RECI : ReceiverCustomerInformation
REPR : RTPReceivedCanBeProcessed
RF01 : NotUniqueTransactionReference
RR01 : MissingDebtorAccountOrIdentification
RR02 : MissingDebtorNameOrAddress
RR03 : MissingCreditorNameOrAddress
RR04 : RegulatoryReason
RR05 : RegulatoryInformationInvalid
RR06 : TaxInformationInvalid
RR07 : RemittanceInformationInvalid
RR08 : RemittanceInformationTruncated
RR09 : InvalidStructuredCreditorReference
RR10 : InvalidCharacterSet
RR11 : InvalidDebtorAgentServiceID
RR12 : InvalidPartyID
RTNS : RTPNotSupportedForDebtor
RUTA : ReturnUponUnableToApply
S000 : ValidRequestForCancellationAcknowledged
S001 : UETRFlaggedForCancellation
S002 : NetworkStopOfUETR
S003 : RequestForCancellationForwarded
S004 : RequestForCancellationDeliveryAcknowledgement
SL01 : SpecificServiceOfferedByDebtorAgent
SL02 : SpecificServiceOfferedByCreditorAgent
SL03 : ServiceofClearingSystem
SL11 : CreditorNotOnWhitelistOfDebtor
SL12 : CreditorOnBlacklistOfDebtor
SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
SL14 : MaximumDirectDebitTransactionAmountExceeded
SP01 : PaymentStopped
SP02 : PreviouslyStopped
SPII : RTPServiceProviderIdentifierIncorrect
TA01 : TransmissionAborted
TD01 : NoDataAvailable
TD02 : FileNonReadable
TD03 : IncorrectFileStructure
TK01 : TokenInvalid
TK02 : SenderTokenNotFound
TK03 : ReceiverTokenNotFound
TK09 : TokenMissing
TKCM : TokenCounterpartyMismatch
TKSG : TokenSingleUse
TKSP : TokenSuspended
TKVE : TokenValueLimitExceeded
TKXP : TokenExpired
TM01 : InvalidCutOffTime
TS01 : TransmissionSuccessful
TS04 : TransferToSignByHand
UCRD : UnknownCreditor
UPAY : UnduePayment

Enum"ACCC""ACCP""ACSC""ACTC""ACWP""ACSP""ACWC""AB01""AB02""AB03"

{
  "additionalInformation": "string",
  "reason": {
    "schema": "string",
    "value": "ACCC"
  }
}

Status

outcomestringrequired

APPROVED: The instruction has been approved.
CANCELLED: The instruction has been cancelled.
PENDING: The instruction is pending.
REJECTED: The instruction has been rejected.

Enum"APPROVED""CANCELLED""PENDING""REJECTED"

reasonInfoArray of objects(StatusReasonInfo)non-empty

A list of StatusReasonInfo values providing detailed reason information for the outcome.

{
  "outcome": "APPROVED",
  "reasonInfo": [
    { … }
  ]
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations