Inbound Credit Transfer Authorization

The inbound credit transfer authorization operation is called when a payment authorization to one of your accountholders is received. This event must be followed by an inboundCreditTransferAuthorizationResponse operation to indicate whether the payment will be allowed or not. 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 authorization 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 | inboundCreditTransferAuthorization is used for immediate payments.

Scheme	Applicable
ZA_CREDIT_EFT	✗
ZA_RPP	✓
ZA_RTC	✓

Request

Request Body schema: application/json

creationDateTime required	string <date-time> The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by `date-time` in RFC3339 ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/GrpHdr/CreDtTm ISO2 PACS2 path: /Document/FIToFIPmtStsRpt/GrpHdr/CreDtTm
messageIdentification required	string <= 35 characters A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment. ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/GrpHdr/MsgId ISO2 PACS2 path: /Document/FIToFIPmtStsRpt/GrpHdr/MsgId
paymentScheme required	string (PaymentScheme) Identifies the scheme used for the payment `ZA_RTC`: South African Realtime Clearing scheme `ZA_RPP`: South African Realtime Payments Platform scheme. `ZA_EFT`: South African Electronic Funds Transfer scheme. Enum: "ZA_RTC" "ZA_RPP" "ZA_EFT"
required	object (MessageIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
required	object (TransactionAmounts)
	object (PaymentTypeInformation)
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. ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/CdtTrfTxInf/IntrBkSttlmDt
required	object (Party)
required	object (PaymentAccount) The minimum required fields to represent an account within the Electrum Account mirror. Note that the `primaryIdentifier` is permanent and immutable.
required	object (ParticipantIdentifier)
required	object (Party)
	object (PaymentAccount) The minimum required fields to represent an account within the Electrum Account mirror. Note that the `primaryIdentifier` is permanent and immutable.
required	object (ParticipantIdentifier)
	object (ParticipantIdentifier)
	object (ParticipantIdentifier)
	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. ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/CdtTrfTxInf/InstrForCdtrAgt
	Array of objects (ParticipantIdentifier) <= 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 ISO2 PACS8 path: /Document/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/IntrmyAgt1 ISO2 PACS8 path: /Document/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/IntrmyAgt2 ISO2 PACS8 path: /Document/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/IntrmyAgt3
	Array of objects (ParticipantIdentifier) <= 3 characters Agent between the debtor's agent and the instructing agent. ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/CdtTrfTxInf/PrvsInstgAgt1 ISO2 PACS8 path: /Document/FIToFICstmrCdtTrf/CdtTrfTxInf/PrvsInstgAgt2
	object (PurposeType) Specifies the underlying reason for the payment transaction
	object (RemittanceInformation)
	object (TaxInformation)

Responses

202

The request has been accepted but processing is not yet complete.

400

Bad Request

500

Unexpected server error

503

Service unavailable

post/transactions/inbound/credit-transfer-authorization

Request samples

Payload

application/json

{"creationDateTime": "2022-05-04T03:02:01.000Z",
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"paymentScheme": "ZA_RTC",
"amounts": {"bankSettlementAmount": {"value": 1,
"currency": "ZAR"
}
},
"creditor": {"name": "Unknown"
},
"creditorAccount": {"identification": {"identificationType": "institution",
"identification": "22222222222"
},
"type": {"valueType": "CODE",
"value": "OTHR"
}
},
"creditorAgent": {"memberId": "210003",
"branch": {"identification": "250655"
}
},
"debtor": {"name": "Unknown"
},
"debtorAccount": {"identification": {"identificationType": "institution",
"identification": "1111111111"
},
"type": {"valueType": "CODE",
"value": "OTHR"
}
},
"debtorAgent": {"memberId": "210010",
"name": "Capitec Bank",
"branch": {"identification": "470010",
"address": {"addressType": "BIZZ",
"countrySubDivision": "WC",
"country": "ZA",
"townName": "STELLENBOSCH"
}
}
},
"identifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"instructingAgent": {"memberId": "210010"
},
"instructedAgent": {"memberId": "210100"
},
"paymentTypeInformation": {"localInstrument": {"valueType": "PROPRIETARY",
"value": "42"
}
},
"remittanceInformation": {"structured": [{"additionalRemittanceInformation": ["CAPITEC"
]
}
],
"unstructured": ["User Reference",
"bdefda31de"
]
}
}

Response samples

application/json

{"category": "BAD_REQUEST",
"message": "Invalid request. Field 'creditTransfer.identifiers.uetr' required but not present."
}