Add Payment Method - Octane REST API

This API will be used to add a new payment method to a Customer account by supplying a single-use token.

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

paymentProvider

enum<string>

required

Specify the payment provider to use for for the Payment Method being added. Currently only QS (QuickStream) is available.

Allowed value:

paymentTokenId

string

required

Specify the Token ID representing the Payment Method to add. Token must be retrieved from the Single-Use Token API.

Example

{
    "paymentProvider": "QS",
    "paymentTokenId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

customerId

string

required

Unique customer token issued by the Payment Provider that this Payment Method is associated with

paymentId

string

required

Unique payment method ID issued by payment provider

paymentType

enum<string>

required

Type of Payment Method. Either Credit Card Details or Bank Account Details will be returned depending on this value.

Allowed values:

CREDIT_CARDDIRECT_DEBIT

isDefault

boolean

optional

Default payment method. Last payment method added is always the default

currency

enum<string>

optional

Currency that payments will be taken in for this method. Currently only AUD is applicable.

Allowed value:

AUD

cardNumber

string

optional

Masked credit card number displaying the first 6 and last 3 digits

cardHolderName

string

optional

The name printed on the card

cardExpiryDateMonth

string

optional

Two digit expiry month

cardExpiryDateYear

string

optional

Four-digit expiry year

cardScheme

enum<string>

optional

Card type

Allowed values:

MASTERCARDVISAAMEXDINERS

maskedCardNumber4Digits

string

optional

Masked credit card number displaying the first 6 and last 4 digits

panType

enum<string>

optional

FPAN (default) - the card number from a physical card. Also known as "Funding PAN".

Allowed value:

FPAN

bsb

string

optional

The bank-state-branch holding their account

bankDisplayName

string

optional

The bank account display name

bankAccountName

string

optional

Name of bank account holder.

bankAccountNumber

string

optional

The account number at that branch

Example

[
    {
        "customerId": "124454554",
        "paymentId": "C42432432442",
        "paymentType": "DIRECT_DEBIT",
        "currency": "AUD",
        "bsb": "012-345",
        "bankAccountName": "Tim Wilkinson",
        "bankAccountNumber": "5243243242",
        "bankDisplayName": "NAB",
        "isDefault": false
    },
    {
        "customerId": "82432424",
        "paymentId": "C3323243242",
        "paymentType": "CREDIT_CARD",
        "currency": "AUD",
        "cardNumber": "589360...668",
        "cardHolderName": "Alton Von",
        "cardExpiryDateMonth": "02",
        "cardExpiryDateYear": "28",
        "cardScheme": "MASTERCARD",
        "maskedCreditCardNumber4Digits": "589360...4668",
        "panType": "FPAN",
        "isDefault": true
    }
]

🟠403Invalid access