The Electrum Account Payments Service describes an interface for performing account payments transactions. These transactions require a reference number which uniquely identifies the account processor, account issuer, as well as the customer account, and is typically printed on a customer invoice. The customer then makes use of this reference number to make a payment towards the corresponding account. This API is often used to pay bills or to top up accounts.
https://[placeholder].dev/billpay/v4/
Parameters pertaining to the generation of the PIN block. Required if the service is to perform any operations on the encrypted PIN, such as translation.
PIN block format that was used when encrypting the PIN. Defaults to ISO_9564_FORMAT_0.
12 digit account number used when encrypting the PIN. When account number is a card number (PAN), this is the rightmost 12 digits excluding the check digit.
Index of the key under which the PIN block is encrypted. Where keys are exchanged in TR-31 KeyBlock format, this should be set to the key version number field of the key used for encryption. If this field is not populated, the most recently exchanged key will be used. Note that omitting this field may require a higher level of synchronization during automated key exchange in some environments.
{ "pinBlockFormat": "ISO_9564_FORMAT_0", "accountNumber": "string", "keyIndex": 0 }
Represents the outcome of a completed transaction
The type of error that occurred
The type of request being processed when the error occurred. Refer to Release Notes for deprecated values.
The UUID of the original request message in the case of an error occurring for an advice message.
{ "errorType": "DUPLICATE_RECORD", "errorMessage": "string", "requestType": "ACCOUNT_LOOKUP_REQUEST", "id": "string", "originalId": "string", "detailMessage": {} }
https://[placeholder].dev/billpay/v4/billers
Failed to generate code sample.{ "billers": [ { … } ] }
Requests all bills related to a specific reference number. The reference number can be in the form of a traffic fine notice number, ID number, or account reference number. Not all reference types are supported by all service providers and in these cases a 501 HTTP status code may be returned.
An enumerated value describing which bills to return, e.g., traffic fines or account bills.
The ID that uniquely identifies each device or system in an originator's institution that is capable of sending requests
Identifies the institution from which the transaction originates. Value to be assigned by Electrum.
https://[placeholder].dev/billpay/v4/bills/{referenceNumber}
Failed to generate code sample.OK
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision.
An array of identifiers that identify the transaction within each entity's system
A list of all bills related to a reference number. If no bills were found, this defaults to an empty list
{ "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "bills": [ { … } ], "paymentOriginatorDetailsRequired": false }
In the case where a payment request reaches a timeout, the purchaseStatus operation should be used to determine the outcome of a prior payment. This operation will return the same PurchaseResponse or ErrorDetail as would have been returned had the original purchase completed normally. This operation should only be used for facilitating a single to dual flow on a digital channel.
https://[placeholder].dev/billpay/v4/payments/status/{paymentMsgId}
Failed to generate code sample.OK
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a customer account.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "account": { "accountRef": "string", "dueDate": "2019-08-24" }, "tenders": [ { … } ], "paymentMethods": [ { … } ] }
A traffic fine payment request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
A reference number identifying the traffic fine to the service provider.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Contains the payment method for the payment request if available
https://[placeholder].dev/billpay/v4/payments/traffic/{paymentId}
Failed to generate code sample.Created
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a traffic fine.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "trafficFine": { "noticeNumber": "string", "dueDate": "2019-08-24" } }
A payment request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
A reference number identifying the bill payments processor, bill issuer, and customer
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Contains the payment method for the payment request if available
https://[placeholder].dev/billpay/v4/payments/{paymentId}
Failed to generate code sample.Created
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a customer account.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "account": { "accountRef": "string", "dueDate": "2019-08-24" }, "tenders": [ { … } ], "paymentMethods": [ { … } ] }
If a payment request (createPayment operation) is successful, and returns a 201 status, it must be confirmed or cancelled in order to complete the transaction. Confirmation of a payment (this operation) will only succeed if the payment was previously created, but not cancelled. This operation must be repeated until a final HTTP status code is received (i.e. 202 or 400). If a 5xx status code is received, or no response is received, the request must be repeated. The confirmation operation is idempotent and may be called repeatedly on the same payment resource without adverse effect.
A payment confirmation
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
An array of tenders used to pay for the transaction
The type of account
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Amount in minor denomination, e.g. R799.95 is encoded as 79995
Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710
A PCI compliant masked card number, with at least the first 6 digits in the clear. Only applicable to card based transactions
https://[placeholder].dev/billpay/v4/payments/{paymentId}/confirmations/{adviceId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
If a payment request (createPayment operation) fails with a 5xx HTTP status code, or no response was received within the timeout limit, it must be reversed. This is to ensure that the payment is not reflected on the customer's account. The reversal (this operation) must be repeated until a final HTTP status code is received (i.e. 202 or 400). The operation is idempotent and so may be called repeatedly on the same payment resource without adverse effect.
A payment reversal
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/payments/{paymentId}/reversals/{adviceId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
If a payment is completed and confirmed successfully, some services allow customers to request a refund for a limited time after the payment took place. Not all service providers support refunds. In the case where this function is not supported, a 501 HTTP status code will be returned
A refund request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
An identifier that is printed on the customer slip and uniquely identifies the payment on the bill issuer's system. This value is used by the customer to request a refund when the service supports this function. It is thus important that this number is unique.
https://[placeholder].dev/billpay/v4/refunds/{refundId}
Failed to generate code sample.Created
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "account": { "accountRef": "string", "dueDate": "2019-08-24" }, "trafficFine": { "noticeNumber": "string", "dueDate": "2019-08-24" }, "policy": { "policyNumber": "string", "dueDate": "2019-08-24" } }
If a refund request (createRefund operation) previously succeeded with a 201 status it must be confirmed or reversed to complete the transaction. The refund confirmation (this operation) can only succeed if a refund was created but not reversed. The operation must be repeated until a final HTTP status code is received (i.e. 202 or 400). If a 5xx status code is received, or no response is received, the request must be repeated. The operation may be called repeatedly on the same refund resource without adverse effect.
A refund confirmation
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/refunds/{refundId}/confirmations/{adviceId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
If a refund request (createRefund operation) fails with a 5xx HTTP status code, or no response was received within the timeout period, it must be reversed. This is to ensure the refund is not refelected on a customer's account. The refund reversal (this operation) must be repeated until a final HTTP status code is received (i.e. 202 or 400). The operation is idempotent and may be called repeatedly on the same payment resource without adverse effect.
A refund reversal
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/refunds/{refundId}/reversals/{adviceId}
Failed to generate code sample.Accepted
The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.
The System Trace Audit Number can be used to locate transactions across different systems.
{ "id": "string", "requestId": "string", "time": "2019-08-24T14:15:22Z", "thirdPartyIdentifiers": [ { … } ], "stan": "string", "rrn": "string", "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … } } }
A policy lookup request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/accountLookups/policy/{requestId}
Failed to generate code sample.OK
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a customer policy. Replaced by a general Bill object in v4.14.0.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "policy": { "policyNumber": "string", "dueDate": "2019-08-24" } }
Requests information related to a specific traffic fine as identified by the noticeNumber. In the case where this function is not supported by the service provider, a 501 HTTP status code will be returned.<br><br>This operation is deprecated. Use lookupBills instead.
A traffic fine lookup request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/accountLookups/traffic/{requestId}
Failed to generate code sample.OK
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a traffic fine.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "trafficFine": { "noticeNumber": "string", "dueDate": "2019-08-24" } }
An account lookup request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
https://[placeholder].dev/billpay/v4/accountLookups/{requestId}
Failed to generate code sample.OK
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a customer account.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "account": { "accountRef": "string", "dueDate": "2019-08-24" }, "paymentOriginatorDetailsRequired": false }
A policy payment request
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
A reference number identifying the policy to the service provider.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Contains the payment method for the payment request if available
https://[placeholder].dev/billpay/v4/payments/policy/{paymentId}
Failed to generate code sample.Created
A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.
The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122
The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision
The Originator object encapsulates data relating to the originator of the transaction
Originating, acquiring, processing, or receiving institution details
The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices
Merchant related data. Must be included if available
The assigned four digit merchant category code
The assigned merchant identifier. Also known as card acceptor id
A container object representing the Merchant Name and Location
The merchant or trading as name associated with the merchant
The city where the merchant is located
The state or region where the merchant is located
The ID that uniquely identifies the person operating the terminal specified by the terminalId field.
Originating, acquiring, processing, or receiving institution details
Originating, acquiring, processing, or receiving institution details
An array of identifiers which each identify the transaction within each entity's system.
Data that may be printed on the customer slip for information purposes
An array of text lines and optional formatting to be printed on the customer slip.
An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.
Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.).
This specifies the type of source account being used in the transaction (i.e. cheque, savings).
This specifies the type of destination account being used in the transaction (i.e. cheque, savings).
The System Trace Audit Number can be used to locate transactions across different systems.
Amounts which make up the transaction. Absent amounts have zero value.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.
An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT
Indicates whether a payment amount may be less than the amount due. Defaults to true.
Indicates whether a payment amount may be more than the amount due. Defaults to true.
Represents the status of a customer policy. Replaced by a general Bill object in v4.14.0.
{ "transactionLabels": [ { … } ], "id": "string", "time": "2019-08-24T14:15:22Z", "originator": { "institution": { … }, "terminalId": "stringst", "merchant": { … }, "operatorId": "string", "channelId": "string" }, "client": { "id": "string", "name": "string" }, "settlementEntity": { "id": "string", "name": "string" }, "receiver": { "id": "string", "name": "string" }, "thirdPartyIdentifiers": [ { … } ], "slipData": { "messageLines": [ … ], "slipWidth": 0, "issuerReference": "string", "phoneNumber": "string" }, "basketRef": "string", "tranType": "GOODS_AND_SERVICES", "srcAccType": "DEFAULT", "destAccType": "DEFAULT", "stan": "string", "rrn": "string", "customer": { "firstName": "string", "lastName": "string", "address": "string", "idNumber": "string", "idType": "NATIONAL_ID", "contactNumber": "string" }, "amounts": { "requestAmount": { … }, "approvedAmount": { … }, "feeAmount": { … }, "balanceAmount": { … }, "additionalAmounts": { … }, "maxPayableAmount": { … }, "minPayableAmount": { … } }, "partPaymentAllowed": false, "overPaymentAllowed": false, "policy": { "policyNumber": "string", "dueDate": "2019-08-24" } }