Step 3: Send Inbound Credit Transfer Authorisation Response

Overview

In this step you communicate the outcome of Step 2 to Electrum as an asynchronous response. This means you are initiating a new call to the Electrum API to deliver the authorisation result.

Both positive and negative outcomes of the authorisation are transmitted using the same response format. If the outcome is positive and you are able to successfully receive the inbound payment, then this step will be followed by a completion step to confirm that you may credit the recipient's account. If the outcome is negative and you are unable to receive the payment, then Electrum will relay this to the payment scheme and no further action is required by you.

Implementing the API

Send Outcome

Perform an inboundCreditTransferAuthorisationResponse operation to Electrum's /transactions/inbound/credit-transfer-authorisation-response endpoint.

The full message schema can be found in the API reference documentation. Code and payload samples are shown below.

The outcome of the authorisation is contained in the status field of the payload. If the outcome is negative and the payment cannot be completed, then further information must be provided in the statusReason field.

application/json

{"schema": "PaymentStatusReport",
"messageIdentifiers": {"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"paymentScheme": {"schema": "ZA_RTC",
"schemeData": {"beneficiaryEchoData": "Ab1 xxxxxxxxxxxxxxxx",
"authorisationId": "Ab1 xx"
},
"originalSchemeData": {"userReference": "Ab1 xxxxxxxxxxxxxxxx",
"originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
"businessReference": "11Ab1xxxxx"
}
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"status": {"outcome": "APPROVED",
"reasonInfo": [{"reason": {"schema": "CODE",
"value": "ACSC"
},
"additionalInformation": "Settlement completed on debtor account"
}
]
},
"instructingAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"instructedAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"originalTransactionData": {"creditor": {"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": "90001236549870",
"scheme": {"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"amounts": {"bankSettlementAmount": {"value": 1,
"currency": "ZAR"
},
"instructedAmount": {"value": 1,
"currency": "ZAR"
}
},
"remittanceInformation": {"unstructured": ["some",
"unstructured",
"information"
],
"structured": [{"referredDocuments": [{"type": {"issuer": "AmazeBank123456",
"schema": "CODE",
"value": "CINV"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {"duePayableAmount": {"value": 1,
"currency": "ZAR"
},
"remittedAmount": {"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {"type": {"issuer": "AnotherAmazeBank1234",
"schema": "CODE",
"value": "RADM"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": ["Some",
"Additional",
"Information"
]
}
]
},
"debtor": {"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": "90001236549870",
"scheme": {"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
}
}
}

Receive Acknowledgement

Electrum will respond with an HTTP 202 status if the request can be processed successfully, or an error response if a problem occurs.