Step 1: Receive Inbound Credit Transfer Authorisation

Overview

When Electrum receives an inbound payment request to one of your account holders, various checks are performed. These checks can be grouped under three categories:

  • Industry rules
  • Account validation
  • Proxy resolution and enrichment (PayShap only)

Electrum will perform all required industry rule checks. These include checking against amount limits and time- or date-specific restrictions.

If you are using Electrum for account mirroring, then Electrum will also validate the account details of the beneficiary.

If you are using Electrum for PayShap proxy management, then Electrum will match the incoming proxy to its corresponding account and enrich the payment request message with this information.

Important

If you are not using Electrum for PayShap proxy management, then the inbound credit transfer request will be preceded by a set of requests to your own proxy management system.

Once these checks have been completed, Electrum will deliver an authorisation request to you. This will allow you to confirm that the beneficiary account can receive the funds.

Implementing the API

Receive Request

Electrum sends an inboundCreditTransferAuthorisation request to your /transactions/inbound/credit-transfer-authorisation endpoint. The request will conform to the following schema:
Request Body schema: application/json
required
object (MessageIdentifiers)

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

object (SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

required
object (TransactionIdentifiers)

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

required
object (TransactionAmounts)
required
object (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.

required
object (PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

required
object (InstitutionIdentification)
required
object (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.

object (PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

required
object (InstitutionIdentification)
object (InstitutionIdentification)
object (InstitutionIdentification)
Array of objects (Instruction) >= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

Array of objects (InstitutionIdentification) <= 3 characters

Agents between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2

required
object (CreditTransferPaymentScheme)

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

object (PaymentTypeInformation)
Array of objects (InstitutionIdentification) <= 3 characters

Agent(s) between the debtor's agent and the instructing agent.

object (PurposeType)

Specifies the underlying reason for the payment transaction

object (RemittanceInformation)
schema
required
string
Value: "CreditTransfer"
settlementDate
string <date>

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

object (TaxInformation)
application/json
{
  • "schema": "CreditTransfer",
  • "messageIdentifiers": {
    },
  • "paymentScheme": {
    },
  • "transactionIdentifiers": {
    },
  • "amounts": {
    },
  • "paymentTypeInformation": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "instructingAgent": {
    },
  • "instructedAgent": {
    },
  • "instructionForCreditorAgent": [
    ],
  • "intermediaryAgents": [
    ],
  • "previousInstructingAgents": [
    ],
  • "purpose": {
    },
  • "remittanceInformation": {
    },
  • "tax": {
    },
  • "supplementaryData": {
    }
}

Respond With Success

If you receive the request successfully and are able to submit it for asynchronous processing, then respond with an HTTP 202 status.

Respond With An Error

If you experience an error while handling the request and are unable to submit it for asynchronous processing, then respond with an appropriate error response. Electrum will respond to the scheme that the payment has been declined. No further action from you is required for this transaction.

Timeout

If Electrum does not receive either an acknowledgement or an error response from you within the appropriate time limit then Electrum will respond to the scheme that the payment was unsuccessful. No further action is required from you.

Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.