Webhook payloads

This is currently available for testing in the sandbox environment

Production Implementation: 7th May 2024

Previously, our webhook implementation required API users to make subsequent calls to the Pay Advantage API to obtain additional data about the received webhook. However, we've improved this experience by directly providing the payload that would typically be acquired through such API calls. This enhancement significantly reduces the need for extensive developer coding and enables immediate action upon receiving the webhook.

If you prefer not to include the webhook payload data in your webhook, we can ensure that you are excluded from the latest webhook update.

Example payload:

[
    {
        "Code": "1FFDB5FA",
        "MerchantCode": "PA12345",
        "DateCreated": "2024-04-02T15:38:02.487+00:00",
        "DateUpdated": "2024-04-02T15:38:08.527+00:00",
        "Event": "payment.created",
        "ResourceCode": "9SFUZA",
        "ResourceUrl": "https://test.payadvantage.com.au/payments/9SFUZA",
        "EndpointCode": "TSFUZA",
        "EndpointUrl": "http://mysite.com/pawebhook",
        "Status": "sending",
        "Data": {
            "Code": "9SFUZA",
            "DateCreated": "2024-04-03T02:37:54.640+11:00",
            "DatePaid": "2024-04-03T02:37:54.640+11:00",
            "DateFailed": null,
            "DateClears": "2024-04-04T00:00:00.000+11:00",
            "DateSettled": null,
            "DateUpdated": "2024-04-03T02:37:54.640+11:00",
            "ReadyToSettle": true,
            "FailCode": null,
            "FailReason": null,
            "PaymentType": "realtime_credit_card",
            "Amount": 34,
            "AmountIncFees": 35.34,
            "AmountRefunded": 0,
            "Customer": {
                "Code": "PF2UZA",
                "Name": "John Davies"
            },
            "BPAYReference": null,
            "ExternalID": null,
            "ExternalReference": null,
            "SettlementCode": null,
            "DDR": null
        }
    }
]

For information on the full release visit: https://help.payadvantage.com.au/hc/en-us/articles/9431396305935-Pay-Advantage-8-16-0

DDR payment API uplift

Payment to DDR query

We've simplified the process of associating a DDR with a payment. With the newly introduced feature enabling search by ddr.code in the GET /payments endpoint and the inclusion of ddr.code within the payment record itself, linking payments to specific DDRs has become effortless. Now, you can seamlessly identify which payments correspond to which DDRs, streamlining your workflow.

Search payments using DDR Code

curl --request GET --url 
'https://api.test.payadvantage.com.au/v3/payments?ddr.code=AAAAAA' 
--header 'accept: application/json'

DDR Code available on the payment record

{
  "Records": [
    {
      "Code": "ABC123",
      "DateCreated": "2023-12-07",
      "DateFailed": null,
      "DateClears": "2023-12-12",
      "DateSettled": "2023-12-12",
      "DateUpdated": "2023-12-12",
      "ReadyToSettle": true,
      "FailCode": null,
      "FailReason": null,
      "PaymentType": "realtime_credit_card",
      "Amount": 200,
      "AmountIncFees": 205,
      "AmountRefunded": 3,
      "DDR": {
        "Code": "AAAAAA"
      },
      "Customer": {
        "Code": "ABC123",
        "Name": "Bob Smith"
      },
      "BPAYReference": "123456789",
      "ExternalID": "Your External ID",
      "SettlementCode": "AABB12"
    }
  ],
  "Meta": {
    "page": 1,
    "recs_per_page": 1,
    "total_recs": 1
  }
}

Webhook Data payloads

Previously, our webhook implementation required API users to make subsequent calls to the Pay Advantage API to obtain additional data about the received webhook. However, we've improved this experience by directly providing the payload that would typically be acquired through such API calls. This enhancement significantly reduces the need for extensive developer coding and enables immediate action upon receiving the webhook.

If you prefer not to include the webhook payload data in your webhook, we can ensure that you are excluded from the latest webhook update.

Example payload:

For information on the full release visit: https://help.payadvantage.com.au/hc/en-us/articles/9351555245839-Pay-Advantage-8-15-0

Introducing Apple and Google pay

New payment type

The introduction of Apple and Google pay has added two new payment types. These payment types will be returned from the GET /payments API call and the paymentType will be either "google_pay" or "apple_pay".

Sample response

{
    "Code": "VKFUZA",
    "DateCreated": "2024-03-22T18:49:56.180+11:00",
    "DatePaid": "2024-03-22T18:49:56.180+11:00",
    "DateFailed": null,
    "DateClears": "2024-03-25T00:00:00.000+11:00",
    "DateSettled": null,
    "DateUpdated": "2024-03-22T18:49:56.180+11:00",
    "ReadyToSettle": true,
    "FailCode": null,
    "FailReason": null,
    "PaymentType": "google_pay",
    "Amount": 23.00,
    "AmountIncFees": 23.76,
    "AmountRefunded": 0.00,
    "Customer": {
        "Code": "2T9UZA",
        "Name": "Jorge Washington"
    },
    "BPAYReference": null,
    "ExternalID": null,
    "ExternalReference": null,
    "SettlementCode": null
}

iFrame changes

To adapt to the recent updates, please consult the documentation that details the new events: device-complete and device-error. These events are triggered when a user selects the Apple Pay or Google Pay option, bypassing the need to enter credit card details, and thus, eliminating the necessity for calling the iFrame authorization. https://docs.payadvantage.com.au/docs/apple-google-payments

For information on the full release visit: https://help.payadvantage.com.au/hc/en-us/articles/9020654160399-Pay-Advantage-8-14-0

Welcome to the developer hub and documentation for Pay Advantage!