Payments

Payments are associated with Customers as well as Debit Instructions. BPAY payments settle immediately whereas Direct Debits and Debit Instructions can take a few days to settle. All payment types can fail for various reasons in which case “DateFailed” and “FailCode” will be populated. On occasion a payment may fail after settlement in the instance of a late failure or chargeback.

 

Payment Record - GET: /payments/{code}

An example of a payment record is shown below. This is the record that is returned on request of a single record and an array of these records is returned when requesting lists. Greyed fields are fields not readily displayed on Pay Advantage screens, but still useful and necessary information such as identifiers and calculated fields.

{
  “Code”: “our system id”,
  “DatePaid”:” 2014-04-20T00:00:00”
  “DateFailed”: null
  “FailCode”: null
  “FailReason”: null
  “Amount”: 100.00,
  “AmountIncFees”: 100.88,
  "ExternalReference":”ABCD1234”,
  "BPAYReference":null,
  “URI”: “/payments/{code}”
}

 

 

Lists of Payment records - GET: /payments

Payments are sorted by Date Paid (descending) by default. The list is paged and will always return the first page of records unless paging parameters are added as described previously. An example of the response is shown below

{
  "Records":
  [
    {
      “Amount”: 100.00,
      “AmountIncFees”: 100.88,
      “Code”: “our system id”,
      “DatePaid”:” 2014-04-20T00:00:00”
      “DateFailed”: null
      “DateClears”: “2014-04-25T00:00:00”,
      “FailReason”: null
    },
    {…}
  ],
  "Meta": { "page":0, "recs_per_page": 100, "total_recs":594 }
}

 

Managing Failed Payments

You can get the list of failed payments for a specific date using the following method:

GET: /payments_failed/{ddMMyyyy}

 

Avoid using todays date as payments can fail at any time during the day and it is best to retrieve these at least one day in arrears.

 

If required you can create more complex filters using the fields available for filtering on payments. For example:

 

Failed payments for a week.

GET: /payments_failed?datefailedfrom=20042014&datefailedto=26042014

 

Failed payments after a date of more than a specific amount.

GET: /payments_failed?datefailedfrom=20042014&amountfrom=100

 

Managing Settled Payments

You can get the list of settled payments for any day using the following method:

GET: /payments_settled/ddMMyyyy

 

If using “today” as the date, it is recommended to run this as late in the day as possible (6pm - Midnight) so that any settlements that occurred during the day are captured.