Provide event data

Provides event details.

Request

Request Body schema: application/json

apiVersion required	string The version of the Electrum Regulated Payments Events API which the event format conforms to i.e. the version of this API.
class required	string The class of the event. ESM_STATE
actionDate required	string <date> The date at which the transaction should take effect. The date must be formatted as defined by `date-time` in RFC3339
creationDateTime required	string <date-time> The date and time at which the event was created, in senders local timezone or UTC. The date must be formatted as defined by `date-time` in RFC3339
	object (EventEsmPayload)
required	object (EventEsmIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
required	object (EventEsmState)
required	object (EventEsmTransactionInfo)

Responses

200

OK. RFC9110 - 200

400

Bad request. RFC9110 - 400

500

Internal server error. RFC9110 - 500

post/events

Request samples

application/json

Request for the inboundCreditTransferAuthorization operation is received by the Switch. A customer at Grey Bank, Bob, is paying a customer at Blue Bank, Alice, using RTC. Electrum's partner is Blue Bank.

{"name": "TRANSACTION_STATE_CREDIT_AUTH_RECEIVED",
"apiVersion": "0.27.0",
"class": "TRANSACTION_STATE",
"type": "CREDIT_AUTH_RECEIVED",
"stageVersion": 1,
"tranInfo": {"tranUetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
"direction": "INBOUND",
"paymentScheme": "ZA_RTC",
"service": "RTC_INBOUND"
},
"messageInfo": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"payload": {"schema": "CreditTransfer",
"messageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"paymentScheme": {"schema": "ZA_RTC",
"schemeData": {"userReference": "Ab1 xxxxxxxxxxxxxxxx",
"originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
"businessReference": "11Ab1xxxxx"
}
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"amounts": {"bankSettlementAmount": {"value": 1,
"currency": "ZAR"
},
"instructedAmount": {"value": 1,
"currency": "ZAR"
}
},
"paymentTypeInformation": {"localInstrument": {"schema": "CODE",
"value": "BTR"
}
},
"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": "bob@grey.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": 90001236549870,
"issuer": "Dept of Home Affairs",
"scheme": {"schema": "CODE",
"value": "NIDN"
}
}
]
}
},
"creditorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Blue Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"creditorAgent": {"bicfi": "BLUEZAJ0",
"memberId": "BlueBankId",
"name": "Blue 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
]
}
}
},
"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": "bob@grey.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": 90001236549870,
"issuer": "Dept of Home Affairs",
"scheme": {"schema": "CODE",
"value": "NIDN"
}
}
]
}
},
"debtorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Grey Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"debtorAgent": {"bicfi": "GREYZAJ0",
"memberId": "GreyBankId",
"name": "Grey 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
]
}
}
},
"instructingAgent": {"bicfi": "GREYZAJ0",
"memberId": "GreyBankId",
"name": "Grey 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": "GREYZAJ0",
"memberId": "GreyBankId",
"name": "Grey 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
]
}
}
},
"instructionForCreditorAgent": [{"code": "TELA",
"information": "Please email example@example.com"
}
],
"intermediaryAgents": [{"bicfi": "GREYZAJ0",
"memberId": "GreyBankId",
"name": "Grey 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
]
}
}
}
],
"previousInstructingAgents": [{"bicfi": "GREYZAJ0",
"memberId": "GreyBankId",
"name": "Grey 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
]
}
}
}
],
"purpose": {"schema": "CODE",
"value": "BKDF"
},
"remittanceInformation": {"unstructured": ["some",
"unstructured",
"information"
],
"structured": [{"referredDocuments": [{"type": {"issuer": "GreyBank123456",
"schema": "CODE",
"value": "CINV"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {"duePayableAmount": {"value": 1,
"currency": "ZAR"
},
"remittedAmount": {"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {"type": {"issuer": "GreyBank1234",
"schema": "CODE",
"value": "RADM"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": ["Some",
"Additional",
"Information"
]
}
]
},
"tax": {"totalAmount": {"value": 1,
"currency": "ZAR"
}
}
}
}