lookupBills

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.

SecurityhttpBasic or oauth2
Request
path Parameters
referenceNumber
required
string

The reference number to use for the lookup

query Parameters
billsType
required
string

An enumerated value describing which bills to return, e.g., traffic fines or account bills.

Enum: "TRAFFIC_FINES" "ACCOUNT_BILLS"
requestId
string

The unique ID of this request

merchantId
string

The assigned merchant identifier. Also known as card acceptor ID.

terminalId
string

The ID that uniquely identifies each device or system in an originator's institution that is capable of sending requests

originatorInstId
string

Identifies the institution from which the transaction originates. Value to be assigned by Electrum.

receiverId
string

Originating, acquiring, processing, or receiving institution details

basketRef
string

Used to group multiple transactions which would otherwise be considered independent

originatorCountryCode
string

The country code where the originator is located from ISO 3166-1 alpha-2, e.g. South African country code is encoded as ZA

Responses
200

OK

400

Bad request

500

Internal server error

501

Not implemented

503

Service unavailable

504

Gateway timeout

get/bills/{referenceNumber}
Request samples
Response samples
application/json
{
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "thirdPartyIdentifiers": [
    ],
  • "customer": {
    },
  • "bills": [
    ]
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.