Accounts API

Accounts store the details of cards or bank accounts to be used for payment.

Use this resource to retrieve and modify existing accounts. To register new accounts, see Register account. All accounts registered against a customer can be listed using List accounts.

Get

Get the details of an account.

Request

GET /accounts/{accountToken}

Use your Secret API key to access this resource.

Path parameters

Request body

None.

Response

If successful, this method returns the Customer Account Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

List accounts

List all enabled credit card and bank accounts for the customer referenced by the path parameter.

Request

GET /customers/{customerId}/accounts

Use your Secret API key to access this resource.

Path parameters

Request body

None.

Response

This is a paginated resource. The list is sorted to show the most recently registered accounts first.

HTTP status codes

See HTTP Status Codes for more.

Register account

Use this resource to register a new credit card or bank account for the customer referenced by the path parameter. This account can then be used to take a payment or create a recurring payment.

The created account will have a unique identifier called the account token, which can be used for payments. If the account details match an existing account for the customer, that account will be updated and returned instead.

There are several different ways to register an account:

• Single-use-token registrations - for registering accounts through a webpage.
• Receipt number registrations - for registering accounts using existing transactions.
• Direct registrations - for registering accounts through your own server. Using this type of request will mean credit card data may be passing through your system. As a result, there may be extra PCI DSS considerations for your environment.

Request

POST /customers/{customerId}/accounts

Use your Secret API key to access this resource.

Path parameters

Request body

Include one of the following fields in the request body:

If you are using EMV 3D Secure, also include the following field:

If you are using Scheme Tokenisation, also include the following field:

{
    "singleUseTokenId": "dec2075f-da92-49df-8a92-f7e494f89c22"
}

{
    "receiptNumber": "123456789"
}

{
    "creditCard": {
        "cardholderName" : "Jane Smith",
        "cardNumber" : "4242424242424242",
        "expiryDateMonth": "12",
        "expiryDateYear": "2022"
    }
}

Response

If successful, this method returns the registered Customer Account Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Register account without customer details

Use this resource to register a new credit card or bank account without customer details or referencing a specific customer identifier in the path. This account can then be used to take a payment or create a recurring payment.

This endpoint will create a new Customer with a generated customerNumber. It is the same process as calling Create customer and then Register customer account.

The created account will have a unique identifier called the account token, which can be used for payments. If the account details match an existing account for the customer, that account will be updated and returned instead.

There are several different ways to register an account:

• Single-use-token registrations without customer details - for registering accounts through a webpage.
• Receipt number registrations without customer details - for registering accounts using existing transactions.
• Direct registrations without customer details - for registering accounts through your own server. Using this type of request will mean card data may be passing through your system. As a result, there may be extra PCI DSS considerations for your environment.

Request

POST /accounts

Use your Secret API key to access this resource.

Path parameters

None.

Request body

Include one of the following fields in the request body:

If you are using EMV 3D Secure, also include the following field:

If you are using Scheme Tokenisation, also include the following field:

If you are registering customers against businesses, also include the following field:

{
    "singleUseTokenId": "dec2075f-da92-49df-8a92-f7e494f89c22"
}

{
    "receiptNumber": "123456789"
}

{
    "creditCard": {
        "cardholderName" : "Jane Smith",
        "cardNumber" : "4242424242424242",
        "expiryDateMonth": "12",
        "expiryDateYear": "2022"
    }
}

Response

If successful, this method returns the registered Customer Account Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Update

Make this account the default account for the owning customer, or update the account name or credit card expiry date.

Request

PATCH /accounts/{accountToken}

Use your Secret API key to access this resource.

Path parameters

Request body

Response

If successful, this method returns the updated Customer Account Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Disable

Disable an account to remove the ability to take new payments or start recurring payment schedules. A disabled account will no longer be usable for payments or able to be retrieved or modified through List accounts, Get account or Update account.

Request

DELETE /accounts/{accountToken}

Use your Secret API key to access this resource.

Path parameters

Request body

None.

Response

If successful, this method will return an empty response body.

HTTP status codes

See HTTP Status Codes for more.

Card account request model

Scheme tokenisation request model

To make a single-use-token scheme tokenisation registration

{
    "singleUseTokenId": "dec2075f-da92-49df-8a92-f7e494f89c22",
    "schemeTokenisation": {
      "emailAddress": "mycustomer@customerbusiness.com.au",
      "ipAddress": "192.168.1.254"
    }
}

To make a direct card scheme tokenisation registration

{
    "creditCard": {
        "cardholderName" : "Jane Smith",
        "cardNumber" : "4242424242424242",
        "expiryDateMonth": "12",
        "expiryDateYear": "2022",
        "cvn" : "123"
    },
    "schemeTokenisation": {
      "emailAddress": "mycustomer@customerbusiness.com.au",
      "ipAddress": "192.168.1.254"
    }
}

Bank account request model

To make a direct Australian bank account registration:

{
    "bankAccount": {
        "accountName" : "Jane Smith",
        "bsb" : "032-000",
        "accountNumber": "123410"
    }
}

Customer account model

A customer account is one of:

• Credit card
• Bank account
• New Zealand bank account

Credit card model

Example credit card response

{
    "accountType": "CREDIT_CARD",
    "accountToken": "MYCOMPANY-123456789",
    "defaultAccount": true,
    "cardNumber": "424242...242",
    "expiryDateMonth": "01",
    "expiryDateYear": "17",
    "cardScheme": "VISA",
    "cardType": "CREDIT",
    "cardholderName": "Jane Smith",
    "maskedCardNumber4Digits": "424242...4242",
    "panType": "FPAN",
    "customerId" : 123456789,
    "links": []
}

Bank account model

Example bank account response

{
    "accountType": "DIRECT_DEBIT",
    "accountToken": "MYCOMPANY-123456780",
    "defaultAccount": true,
    "accountName": "Jane's Bank Account",
    "displayName": "Jane's Bank Account",
    "currency": "AUD",
    "bsb": "032-000",
    "accountNumber": "123465",
    "customerId" : 123456789,
    "links": []
}

New Zealand bank account model

Example New Zealand bank account response

{
    "accountType": "DIRECT_DEBIT_NZ",
    "accountToken": "MYCOMPANY-123456780",
    "defaultAccount": true,
    "nzAccountName": "Jane's Bank Account",
    "displayName": "Jane's Bank Account",
    "currency": "NZD",
    "nzBankCode": "01",
    "nzBranchCode": "0001",
    "nzAccountNumber": "0000001",
    "nzAccountSuffix": "00",
    "links": []
}