A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.
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 (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time. |
required | object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction. |
object (InstitutionIdentification) | |
object (InstitutionIdentification) | |
object (OriginalRequestToPayData) Contains key elements related to the original request to pay that is being referred to. | |
object (RequestToPayConditions) Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered. | |
schema required | string Value: "RequestToPayResponse" |
required | object (RequestToPayStatus) |
{- "messageIdentifiers": {
- "creationDateTime": "2019-08-24T14:15:22Z",
- "messageIdentification": "string"
}, - "supplementaryData": {
- "property1": "string",
- "property2": "string"
}, - "originalMessageIdentifiers": {
- "creationDateTime": "2019-08-24T14:15:22Z",
- "messageIdentification": "string"
}, - "transactionIdentifiers": {
- "endToEndIdentification": "string",
- "transactionIdentification": "string",
- "uetr": "string"
}, - "instructedAgent": {
- "additionalIdentifications": [
- {
- "accountKnownAs": "string",
- "identifier": {
- "schema": "string",
- "value": "string"
}, - "registeredSchemes": [
- "ZA_RTC"
]
}
], - "bicfi": "string",
- "branch": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "identification": "string",
- "name": "string"
}, - "companyRegistration": "string",
- "lei": "string",
- "memberId": "string",
- "name": "string"
}, - "instructingAgent": {
- "additionalIdentifications": [
- {
- "accountKnownAs": "string",
- "identifier": {
- "schema": "string",
- "value": "string"
}, - "registeredSchemes": [
- "ZA_RTC"
]
}
], - "bicfi": "string",
- "branch": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "identification": "string",
- "name": "string"
}, - "companyRegistration": "string",
- "lei": "string",
- "memberId": "string",
- "name": "string"
}, - "originalRequestToPayData": {
- "amounts": {
- "bankSettlementAmount": {
- "currency": "string",
- "value": 0
}, - "instructedAmount": {
- "currency": "string",
- "value": 0
}
}, - "creditor": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "contactDetails": {
- "emailAddress": "user@example.com",
- "mobileNumber": "string",
- "phoneNumber": "string"
}, - "countryOfResidence": "string",
- "identification": {
- "identifiers": [
- {
- "identification": "string",
- "issuer": "string",
- "scheme": {
- "schema": "string",
- "value": "ARNU"
}
}
], - "schema": "string"
}, - "knownAsName": "string",
- "legalName": "string"
}, - "creditorAccount": {
- "currency": "string",
- "identification": {
- "schema": "string",
- "value": "string"
}, - "name": "string",
- "proxy": {
- "namespace": "string",
- "schema": "string"
}, - "type": {
- "schema": "string",
- "value": "CACC"
}
}, - "creditorAgent": {
- "additionalIdentifications": [
- {
- "accountKnownAs": "string",
- "identifier": {
- "schema": "string",
- "value": "string"
}, - "registeredSchemes": [
- "ZA_RTC"
]
}
], - "bicfi": "string",
- "branch": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "identification": "string",
- "name": "string"
}, - "companyRegistration": "string",
- "lei": "string",
- "memberId": "string",
- "name": "string"
}, - "debtor": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "contactDetails": {
- "emailAddress": "user@example.com",
- "mobileNumber": "string",
- "phoneNumber": "string"
}, - "countryOfResidence": "string",
- "identification": {
- "identifiers": [
- {
- "identification": "string",
- "issuer": "string",
- "scheme": {
- "schema": "string",
- "value": "ARNU"
}
}
], - "schema": "string"
}, - "knownAsName": "string",
- "legalName": "string"
}, - "debtorAccount": {
- "currency": "string",
- "identification": {
- "schema": "string",
- "value": "string"
}, - "name": "string",
- "proxy": {
- "namespace": "string",
- "schema": "string"
}, - "type": {
- "schema": "string",
- "value": "CACC"
}
}, - "debtorAgent": {
- "additionalIdentifications": [
- {
- "accountKnownAs": "string",
- "identifier": {
- "schema": "string",
- "value": "string"
}, - "registeredSchemes": [
- "ZA_RTC"
]
}
], - "bicfi": "string",
- "branch": {
- "address": {
- "addressLine": [
- "string"
], - "addressType": "ADDR",
- "buildingName": "string",
- "buildingNumber": "string",
- "country": "string",
- "countrySubDivision": "string",
- "department": "string",
- "districtName": "string",
- "floor": "string",
- "postBox": "string",
- "postCode": "string",
- "streetName": "string",
- "townLocationName": "string",
- "townName": "string"
}, - "identification": "string",
- "name": "string"
}, - "companyRegistration": "string",
- "lei": "string",
- "memberId": "string",
- "name": "string"
}, - "expiryDateTime": "2019-08-24T14:15:22Z",
- "paymentTypeInformation": {
- "localInstrument": {
- "schema": "string",
- "value": "0000"
}
}, - "remittanceInformation": {
- "structured": [
- {
- "additionalRemittanceInformation": [
- "string"
], - "creditorReference": {
- "reference": "string",
- "type": {
- "issuer": "string",
- "schema": "CODE"
}
}, - "originatorReference": "string",
- "referredDocumentAmount": {
- "duePayableAmount": {
- "currency": "string",
- "value": 0
}, - "remittedAmount": {
- "currency": "string",
- "value": 0
}
}, - "referredDocuments": [
- {
- "documentIdentifier": "string",
- "type": {
- "issuer": null,
- "schema": null
}
}
]
}
], - "unstructured": [
- "string"
]
}, - "requestToPayConditions": {
- "maxAmount": {
- "currency": "string",
- "value": 0
}, - "minAmount": {
- "currency": "string",
- "value": 0
}
}
}, - "requestToPayConditions": {
- "maxAmount": {
- "currency": "string",
- "value": 0
}, - "minAmount": {
- "currency": "string",
- "value": 0
}
}, - "schema": "RequestToPayResponse",
- "status": {
- "reasonInfo": [
- {
- "additionalInformation": "string",
- "reason": {
- "schema": "string",
- "value": "AB01"
}
}
], - "status": "PAID"
}
}