API Data Types

Customer

Name Description Type
Code Unique internal identifier assigned to the customer (read-only) string
ExternalID Optional identifier from an external system to be recorded against this customer string
IsConsumer Flag to indicate if customer is of type "Consumer". "false" means customer has type "Business". bool
DateJoined Can be set to a date relevant to when the customer record entered your business. date
Name Business Name or First + Last names of the customer. Only editable for "Business" customers. string
FirstName The first name of a consumer or first name of contact for a business string
LastName The last name of a consumer or last name of contact for a business string
CustomRef Customer reference string
Email Email address of the customer string
BillerCode Biller Code of the customer (read-only) string
(ints only)
BPAYRef BPAY Reference number for the customer (read-only) string
(ints only)
DateUpdated Date & time the customer record was updated (read-only) datetime
DateCreated Date & time the customer record was created (read-only) datetime
CreatedBy.FirstName First name of the account that created the customer (read-only) string
CreatedBy.LastName Last name of the account that created the customer (read-only) string
CreatedBy.UserName User name of the account that created the customer (read-only) string
IsActive Flag to indicate an active customer bool

 

Payment

Name Description Type
Code Unique internal identifier string
DatePaid Date the payment was paid date
DateFailed Date & time the payment failed datetime
DateClears Date the payment is expected to clear and be ready for settlement date
DateSettled Date the cleared payment actually settles datetime
FailCode See failure codes char
FailReason Failure reason if the payment failed string
Amount Payment amount exclusive of on-charged fees decimal
AmountIncFees Amount of the payment including any on-charged fees decimal
ReadyToSettle Flag indicating if the payment is ready for settlement bool
PaymentType The type of payment (see Enums). string
ExternalReference The Reference applied to a related debit instruction string
BPAYReference If payment relates to a BPAY payment string
(ints only)
SettlementCode The identifier of the settlement this payment was included in string


DebitBatch

Name Description Type
Code Unique internal identifier assigned to the batch (read-only) string
DateCreated Date & time the debit batch was created (read-only) datetime
Name Name of the debit batch string
DateToDebit Date to debit the debit batch date
IsConfirmed Flag indicating if the batch is confirmed (read-only) bool
IsAuthorised Flag indicating if the batch has been authorised (read-only) bool
IsProcessed Flag indicating if the batch has been processed (read-only) bool
RemitterName Remitter Name of the batch (read-only) string
DebitInstructionCount Number of debit instructions in the batch (read-only) int
DebitInstructionAmountSum Total amount of the debit instructions in the batch (read-only) decimal
CreatedBy.FirstName First name of the account that created the debit batch (read-only). This will be null for API users. string
CreatedBy.LastName Last name of the account that created the debit batch (read-only). This will be null for API users. string
CreatedBy.UserName User name of the account that created the debit batch (read-only) string

 

DebitInstruction

Name Description Type
Code Unique internal identifier assigned to the instruction (read-only) string
Reference Use this field as an optional placeholder for your own system ID string
GroupKey Use this field to group instructions together. Allows failed on-charged fees to be recovered on subsequent debit attempts. string
DateCreated Date & time the debit instruction was created (read-only) datetime
IsProcessed Flag to indicate if the debit instruction has been processed (read-only) bool
BSBNumber BSB Number of the account to debit string
(ints only)
CreditCardCode Code of a previously stored credit card string
AccountNumber Bank account Number, or Display Hash (read-only) for credit cards string
(ints only)
AccountName Bank Account Name or Card Holder (read-only) for credit cards string
Amount Amount to debit decimal
RemitterName Remitter of the debit instruction (read-only) string
OnchargeFees Flag to indicate if debit fees should be added to amount bool
IsFailAcknowledged Flag to indicate whether a failed debit instruction has been acknowledged (read-only) bool
DebitBatch.Code Unique identifier of parent Debit batch (read-only) string
DebitBatch.DateToDebit Date to Debit of the parent Debit batch (read-only) date
Payment.Code Unique internal identifier of the payment attached to this debit instruction (read-only) string
Payment.Amount The amount of the actual payment inclusive of fees (read-only) decimal
Payment.DatePaid Payment date of the payment attached to this debit instruction (read-only) date
Payment.DateFailed Date of failure of the payment attached to this debit instruction (read-only) date



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