API Data Types

Overview

When reading our API Data Types list we list the minimum and maximum value, and wether the item can be: sorted, filtered, or edited.

 For example:

Name Description

type (min-max)

sortablefilterableeditable

Amount Payment amount exclusive of on-charged fees.

Decimal (0.01-9999)

sortablefilterable (range)

 

Customer

Customer

Name Description Type
Code Unique internal identifier assigned to the customer (read-only).

string (6-12)

filterable

ExternalID Optional identifier from an external system to be recorded against this customer.

string (0-20)

filterableeditable

IsConsumer Flag to indicate if customer is of type "Consumer". "false" means customer has type "Business".

boolean

sortablefilterableeditable

DateJoined Can be set to a date relevant to when the customer record entered your business.

date

sortablefilterable (range)editable

Name Business Name or First + Last names of the customer. Only editable for "Business" customers.

string (1-80)

sortablefilterableeditable

FirstName The first name of a consumer or first name of contact for a business.

string (1-50)

sortablefilterableeditable

LastName The last name of a consumer or last name of contact for a business.

string (1-50)

sortablefilterableeditable

CustomRef Customer reference string.

string (0-20)

sortablefilterableeditable

Email Email address of the customer.

string (0-200)

filterableeditable

BillerCode Biller Code of the customer (read-only).

string ints only (0-8)

BPAYRef BPAY Reference number for the customer (read-only).

string ints only (0-10)

filterable

DateUpdated Date & time the customer record was updated (read-only).

datetime

sortablefilterable (range)

DateCreated Date & time the customer record was created (read-only).

datetime

sortablefilterable (range)

CreatedBy.FirstName First name of the account that created the customer (read-only). string (2-50)
CreatedBy.LastName Last name of the account that created the customer (read-only). string (2-50)
CreatedBy.UserName User name of the account that created the customer (read-only). string (5-255)
IsActive Flag to indicate an active customer.

boolean

filterableeditable

URL URL that directly accesses this customer record.

string (0-255)

 

Payment

Payment

Name Description Type
Code Unique internal identifier.

string (6-12)

filterable

DatePaid Date the payment was paid.

date

sortablefilterable (range)

DateFailed Date & time the payment failed.

datetime

sortablefilterable (range)

DateClears Date the payment is expected to clear and be ready for settlement.

date

filterable (range)

DateSettled Date the cleared payment actually settles.

datetime

sortablefilterable (range)

FailCode See failure codes.

char (1-1)

filterable

FailReason Failure reason if the payment failed. string (6-6)
Amount Payment amount exclusive of on-charged fees.

decimal (0.01-9999)

sortablefilterable (range)

AmountIncFees Amount of the payment including any on-charged fees.

decimal (0.01-9999)

sortablefilterable (range)

ReadyToSettle Flag indicating if the payment is ready for settlement. boolean
PaymentType A description of the payment type.

string (0-50)

ExternalReference The Reference applied to a related debit instruction. string (0-50)
BPAYReference If payment relates to a BPAY payment. string ints only (0-10)
SettlementCode The identifier of the settlement that this payment was included in. string
URL URL that directly accesses this payment record. string (0-255)

 

Debit Batch

DebitBatch

Name Description Type
Code Unique internal identifier assigned to the batch (read-only).

string (6-12)

filterable

DateCreated Date & time the debit batch was created (read-only).

datetime

sortablefilterable (range)

Name Name of the debit batch.

string (1-50)

filterableeditable

DateToDebit Date to debit the debit batch.

date

sortablefilterable (range)editable

IsConfirmed Flag indicating if the batch is confirmed (read-only).

boolean

filterable

IsAuthorised Flag indicating if the batch has been authorised (read-only).

boolean

filterable

IsProcessed Flag indicating if the batch has been processed (read-only).

boolean

filterable

RemitterName Remitter Name of the batch (read-only).

string (0-16)

editable

DebitInstructionCount Number of debit instructions in the batch (read-only).

int

filterable (range)

DebitInstructionAmountSum Total amount of the debit instructions in the batch (read-only).

decimal

filterable (range)

CreatedBy.FirstName First name of the account that created the debit batch (read-only). This will be null for API users.

string (2-50)

sortablefilterable

CreatedBy.LastName Last name of the account that created the debit batch (read-only). This will be null for API users.

string (2-50)

sortablefilterable

CreatedBy.UserName User name of the account that created the debit batch (read-only).

string (5-255)

sortablefilterable

URL URL that directly accesses this debit batch record.

string (0-255)

 

Debit Instruction

DebitInstruction

Name Description Type
Code Unique internal identifier assigned to the instruction (read-only).

string (6-12)

filterable

Reference Use this field as an optional placeholder for your own system ID.

string (0-50)

filterableeditable

GroupKey Use this field to group instructions together. Allows failed on-charged fees to be recovered on subsequent debit attempts.

string (0-50)

filterableeditable

DateCreated Date & time the debit instruction was created (read-only).

datetime

sortablefilterable (range)

IsProcessed Flag to indicate if the debit instruction has been processed (read-only).

boolean

filterable

BSBNumber BSB Number of the account to debit.

string ints only (6-6)

filterableeditable

CreditCardCode Code of a previously stored credit card.

string (6-6)

filterable

AccountNumber Bank account Number, or Display Hash (read-only) for credit cards.

string ints only (5-9)

filterableeditable

AccountName Bank Account Name or Card Holder (read-only) for credit cards.

string (2-50)

filterableeditable

Amount Amount to debit.

decimal (5-9999)

sortablefilterableeditable

RemitterName Remitter of the debit instruction (read-only). string (0-16)
OnchargeFees Flag to indicate if debit fees should be added to amount.

boolean 

filterable

IsFailAcknowledged Flag to indicate whether a failed debit instruction has been acknowledged (read-only).

boolean

filterable

DebitBatch.Code Unique identifier of parent Debit batch (read-only).

string (6-12)

filterable

DebitBatch.DateToDebit Date to Debit of the parent Debit batch (read-only).

date

sortablefilterable (range)

Payment.Code Unique internal identifier of the payment attached to this debit instruction (read-only).

string (6-12)

filterable

Payment.Amount The amount of the actual payment inclusive of fees (read-only).

decimal

filterable

Payment.DatePaid Payment date of the payment attached to this debit instruction (read-only).

date

sortablefilterable (range)

Payment.DateFailed Date of failure of the payment attached to this debit instruction (read-only).

date

sortablefilterable (range)

URL URL that directly accesses this debit instruction record.

string (0-255)

  

Direct Debit

DirectDebit

Name Description Type
Code Unique internal identifier assigned to the direct debit (read-only). string
Description A description of the direct debit (e.g. "Membership Fees"). string
ExternalID Optional identifier from an external system to be recorded against this direct debit. string
DateCreated Date & time the direct debit was created (read-only). datetime
Status The current status of the direct debit (read-only). Possible values are "Draft", "Pending", "Rejected", "Active", "Cancelled", "Complete", "Paused" and "Error". string
OnchargedFees A list of fees to oncharge. Valid values are "dishonour", "perdebit" and "setup" which, if present, will on-charge the payment dishonour, direct debit and per schedule fees respectively. list of string
AmountPaid Amount paid so far on this direct debit (read-only). decimal
Customer.Code Unique identifier of the customer making the direct debit. string
Customer.Name The name of the customer making the direct debit (read-only). string
Customer.CustomRef The customer reference for the custoemr making the direct debit (read-only). string
AuthorisationLink.Link URL to page allowing customer to authorise the DDR (read-only). string
AuthorisationLink.Expiry Date at which the link expires (read-only). datetime
Functions List ocontaining the ongoing and, optionally, the upfront functions for a direct debit. list of Function
Function.Name "Ongoing" or "Upfront". string
Funciton.Amount The upfront or recurring amount. decimal
Function.DateStart The date on which the first amount is to be charged. datetime
Function.Frequency For ongoing functions, specifies the frequency of the charge ("weekly", "fortnightly", "monthly" or "quarterly"). string
Function.FailureOption The action to take on failure to debit
  •  "pause" - Pause the Direct Debit Schedule
  •  "next" - Add to next payment
  •  "1week" - Debit in one week
  •  "2weeks" - Debit in two weeks
  •  "3days" - Debit in three days
  •  "addtoend" - Append after last scheduled payment
string
Function.EndCondition.Amount Schedule payments until the specified amount has been debited. decimal
Function.EndCondition.Date Schedule payments until this date. datetime

 

 

Have more questions? Submit a request

Comments