Authorise an inbound credit transfer synchronously

This operation is synchronous.

The inbound synchronous credit transfer authorisation operation is called when a payment authorisation to one of your accountholders is received and should be accompanied by a response to approve or decline the authorisation request. No funds should be credited at this point; only if a successful subsequent onInboudCreditTransferCompletion event is received should funds be credited. Note, though, that a successful (response code ACCP) completion may not be rejected if the authorisation was approved. Any completions that cannot be applied should be treated as exception cases that require manual intervention by your operational teams.

Note: | This operation differs from the inboundCreditTransfer operation which has immediate financial impact and | does not include a completion leg. Typically, inboundCreditTransfer is used for delayed payments while | inboundSynchronousCreditTransferAuthorisation is used for immediate payments.

Scheme Applicable
ZA_EFT ✗
ZA_RPP ✓
ZA_RTC ✓
Request
header Parameters
traceparent
string (traceparent) ^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

tracestate
string (tracestate) ^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the (W3C Trace Context Level 2 specification (V2))[https://www.w3.org/TR/trace-context-2/].

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)
Responses
200

OK. RFC9110 - 200

Note that a response containing a 200 (OK) HTTP status does not necessarily mean that the response contains a positive outcome but rather that the Partner successfully processed the request and is providing a response. The functional outcome might still be a negative one. In the event that the Partner encounters a technical error when processing a synchronous credit transfer authorisation request, the appropriate 4xx or 5xx response should be used.

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

405

Method not allowed. RFC9110 - 405

422

Unprocessable content. RFC9110 - 422

429

Too Many Requsts. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/transactions/inbound/credit-transfer-authorisation-sync
Request samples
application/json
{
  • "schema": "CreditTransfer",
  • "messageIdentifiers": {
    },
  • "paymentScheme": {
    },
  • "transactionIdentifiers": {
    },
  • "amounts": {
    },
  • "paymentTypeInformation": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "instructingAgent": {
    },
  • "instructedAgent": {
    },
  • "instructionForCreditorAgent": [
    ],
  • "intermediaryAgents": [
    ],
  • "previousInstructingAgents": [
    ],
  • "purpose": {
    },
  • "remittanceInformation": {
    },
  • "tax": {
    },
  • "supplementaryData": {
    }
}
Response samples
application/json
{
  • "schema": "PaymentStatusReport",
  • "messageIdentifiers": {
    },
  • "originalMessageIdentifiers": {
    },
  • "paymentScheme": {
    },
  • "transactionIdentifiers": {
    },
  • "status": {
    },
  • "instructingAgent": {
    },
  • "instructedAgent": {
    },
  • "originalTransactionData": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.