Production implementation date: 21st May 2025

Payment API enhancement

We've expanded the Payment API to allow access to additional fields, enabling more comprehensive data retrieval.

In this update, the following fields have been added:

Description - The payment description
Source - Where the payment originated

Source attribute

The source attribute is to indicate where the payment originated. This can be useful when differentiating payments that are made from payment requests or from a hosted pages link or even from your internal staff team using virtual terminal.

• Origin - "connected_app", "api", "payment_request", "virtual_terminal", "hosted_pages", "bpay", "ddr", "batch_debit"
• CreatedBy
  • FirstName
  • LastName
  • UserName
• Type - "customer", "api", "user", "system"

{
  "Code": "ABC123",
  "DateCreated": "2025-05-06",
  "DateFailed": null,
  "DateClears": "2025-05-11",
  "DateSettled": "2025-05-11",
  "DateUpdated": "2025-05-11",
  "ReadyToSettle": true,
  "FailCode": null,
  "FailReason": null,
  "PaymentType": "electronic",
  "Amount": 200,
  "AmountIncFees": 205,
  "AmountRefunded": 3,
  "AmountChargedback": 3,
  "Customer": {
    "Code": "ABC123",
    "Name": "Bob Smith"
  },
  "BPAYReference": "123456789",
  "ExternalID": "Your External ID",
  "SettlementCode": "AABB12",
  "DDR": {
    "Code": "ABC321"
  },
  "DebitInstruction": {
    "Code": "ABC123321CBA"
  },
  "DebitBatch": {
    "Code": "ABC123"
  },
  "ReceiptLink": "https://www.payadvantage.com.au/receipts/ABC123",
  "Source": {
   	"Origin": "api",
    "CreatedBy": {
      "FirstName": "Bob",
      "LastName": "Franklin",
      "UserName": "[email protected]"
    },
    "type": "api"  
  }
}