API Data Types

Customer

Name Description Type
Code Unique internal identifier. string
ExternalID External reference ID. string
IsConsumer Flag to indicate if this is a Consumer type customer or not. False means customer is a Business type. 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 type 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. string (ints only)
BPAYRef BPAY Reference number for the customer. string (ints only)
DateUpdated Date & time the customer record was updated. datetime
DateCreated Date & time the customer record was created. datetime
CreatedBy.FirstName First name of the account that created the customer. string
CreatedBy.LastName Last name of the account that created the customer. string
CreatedBy.UserName User name of the account that created the customer. 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
PaymentType A description of the payment type 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

Code Unique internal identifier. string
DateCreated Date & time the debit batch was created. datetime
Name Name of the debit batch. string
DateToDebit Date to debit the debit batch. date
IsConfirmed True / False the batch is confirmed. bool
IsAuthorised True / False the batch is authorised. bool
IsProcessed True / False the batch has been processed. Bool
RemitterName Remitter Name of the batch. string
DebitInstructionCount Number of debit instructions in the batch. int
DebitInstructionAmountSum Total amount of the debit instructions in the batch. decimal
CreatedBy.FirstName First name of the account that created the debit batch. string
CreatedBy.LastName Last name of the account that created the debit batch. string
CreatedBy.UserName User name of the account that created the debit batch. string

 

DebitInstruction

Name Description Type
Code Unique internal identifier. 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. datetime
IsProcessed Flag to indicate if the debit instruction has been processed. bool
BSBNumber BSB Number of the account to debit. string (ints only)
CreditCardCode Code of a previously stored credit card string
AccountNumber Account Number of Display hash for credit cards. string (ints only)
AccountName Account Name or Card Holder for credit cards. string
Amount Amount to debit. decimal
RemitterName Remitter of the debit instruction. 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. bool
DebitBatch.Code Unique identifier of parent Debit batch. string
DebitBatch.DateToDebit Date to Debit of the parent Debit batch. date
Payment.Code Unique internal identifier of the payment attached to this debit instruction. string
Payment.Amount The amount of the actual payment (inclusive of fees) decimal
Payment.DatePaid Payment date of the payment attached to this debit instruction. date
Payment.DateFailed Date of failure of the payment attached to this debit instruction. date
Have more questions? Submit a request

Comments