List Bounced Transactions - Octane REST API

This API will be used to list transactions added against a customer account, which can include Payments, Refunds, and Misc Credit/Debits

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

groupno

string

required

Group Number. Users will have access only to specific Groups and must pass this ID when accessing any Resources via API.

custno

integer

required

Provide the Customer Number to retrieve transactions for

Query Params

transactionDateFrom

string

optional

Filter transactions by Date Range. Must be in yyyy-mm-dd format.

Example:

2024-01-01

transactionDateTo

string

optional

Filter transactions by Date Range. Must be in yyyy-mm-dd format.

Example:

2024-01-31

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

custNo

integer

required

Octane Customer Number

tranNo

integer

required

Unique identifer of the transaction for this Customer Account

transactionType

enum<string>

required

The type of transaction that was made.

Allowed values:

PMCMDBCCRD

paymentMethod

enum<string>

optional

The type of payment method for a payment

Allowed values:

APBABPCCCHNPPD

creditCardType

enum<string>

optional

The type of credit card used for a payment

Allowed values:

AXDIMAVI

miscAdjustmentType

enum<string>

optional

The type of misc adjustment type added

Allowed values:

A0A1A2A4A9BB1CAEBF2ICIDMHMMMRO9OCOIOKOLOXP0P1P2RDRFRYSCTPVIVPWH

comment

string

optional

Description of the transaction being added

transactionDate

string <date-time>

required

The datetime that the transaction was made

stmtNo

integer

optional

The statement no that this payment was allocated to

principalAmount

number <double>

required

Amount before any surcharge added. Absolute and rounded down to 2 decimal places

surchargeAmount

number <double>

optional

Amount of surcharge. Surcharge will only be returned for P transactions (if applicable). Rounded down to 2 decimal places

taxAmount

number <double>

optional

Amount of tax applied to this transaction. Tax will only be returned for CC transactions. Rounded down to 2 decimal places

totalAmount

number <double>

required

Total amount of transaction. Principal amount plus surcharge/tax Rounded down to 2 decimal places

currency

enum<string>

required

The currency that the transaction is in

Allowed value:

AUD

dateAdded

string <date-time>

optional

Timestamp of when the transaction was added.

userAdded

string

optional

Timestamp of the user that added the transaction

payment

object (Payment)

optional

For payment transactions, this will return the status of the payment from the payment provider

string

optional

Unique identifier of the Payment Record.

receiptNumber

string

optional

Payment receipt number

status

enum<string>

optional

Use Table Reference. Payment status

Allowed values:

ApprovedApproved*PendingDeclinedVoidedSuspended

transactionDate

string <date-time>

optional

Date and time (if known) when transaction processing was initiated

settlementDate

string <date-time>

optional

The day on which this transaction was considered to have been processed

responseCode

enum<string>

optional

Use Table Reference. Reason code for the status

Allowed values:

0001020304050607080910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747579828390919293949596979899EAEGEMQ1Q2Q3Q4Q8Q9QAQBQCQDQEQFQGQHQIQJQKQLQMQNQOQPQQQRQSQTQUQVQWQXQYQZRARGRMNoNew

responseDescription

string

optional

Reason description for the status

summaryCode

enum<string>

read-onlyoptional

Use Table Reference. Success indicator for the responseCode

Allowed values:

0123

totalAmount

number <double>

optional

Total amount of transaction. Principal amount plus surcharge. Must be in AUD (not cents) and rounded down to 2 decimal places

Example

[
    {
        "custNo": 0,
        "tranNo": 0,
        "transactionType": "P",
        "paymentMethod": "AP",
        "creditCardType": "AX",
        "miscAdjustmentType": "A0",
        "comment": "string",
        "transactionDate": "2019-08-24T14:15:22Z",
        "stmtNo": 0,
        "principalAmount": 0,
        "surchargeAmount": 0,
        "taxAmount": 0,
        "totalAmount": 0,
        "currency": "AUD",
        "dateAdded": "2019-08-24T14:15:22Z",
        "userAdded": "string",
        "payment": {
            "id": "string",
            "receiptNumber": "string",
            "status": "Approved",
            "transactionDate": "2019-08-24T14:15:22Z",
            "settlementDate": "2019-08-24T14:15:22Z",
            "responseCode": "00",
            "responseDescription": "string",
            "summaryCode": "0",
            "totalAmount": 0
        }
    }
]

🟢204No records found

🟠403Invalid access

🟠404Customer not found

🟠400Invalid input