Make Payment - Octane REST API

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.

Example:

123

custno

string

required

Octane Customer Number.

Example:

554433

Body Params application/json

transactionType

enum<string>

required

The type of transaction

Allowed value:

P

paymentTokenId

string

required

External payment gateway issued token. Either a singleUseToken or paymentId must be provided to take payment.

If payment is being made using a new card, a single use token must first be generated via the Trusted Frame implementation and passed here.

If payment is being made using a saved card, the Payment ID retrieved via [List Payment Methods]{api-5032549} must be passed in.

amount

number <double>

required

Payment Amount as whole number or decimal.

comment

string

required

Comments about the transaction being made

receiptEmail

string

required

Email to send the payment receipt to

allowDuplicates

boolean

required

Flag to allow payments that appear to be identical to other payments for the same date.

Example

{
    "transactionType": "P",
    "paymentTokenId": "string",
    "amount": 0,
    "comment": "string",
    "receiptEmail": "string",
    "allowDuplicates": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/group/123/customer/554433/transaction/payment/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "transactionType": "P",
    "paymentTokenId": "string",
    "amount": 0,
    "comment": "string",
    "receiptEmail": "string",
    "allowDuplicates": true
}'

Responses

🟢200OK

application/json

Body

custNo

integer

required

paymentProvider

enum<string>

required

Allowed value:

QS

transactionType

enum<string>

required

Allowed value:

PAYMENT

id

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,
    "paymentProvider": "QS",
    "transactionType": "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
}

🟠403Invalid access