> ## Documentation Index
> Fetch the complete documentation index at: https://epayclub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PayID

> Collect payments via PayID — Australia's bank-to-bank payment network.

Accept payments from Australian customers using PayID, the New Payments Platform (NPP) real-time bank transfer scheme. Customers pay directly from their bank app using a simple identifier — no card details required.

<Info>
  PayID is only available for **AUD** transactions. The customer must have an Australian bank account with PayID enabled. This payment method supports one-time (non-recurring) payments.
</Info>

## Payment flow

Several steps occur between initiating the PayID charge and the payment being confirmed.

<Info>
  We'll proceed assuming you've already set up a customer order. If you need to create one, you'll find the steps [here](/orders/create-orders).
</Info>

After creating the order, follow these steps to complete the PayID charge:

1. [Encrypt](/api-basics/encryption) sensitive data within your request.
2. Redirect the customer to the PayID-hosted payment page to complete the bank transfer.
3. Confirm the payment and inform the customer of its outcome.

<Info>
  All customer details (name, email, phone, country) are sourced from the order created in the previous step. No additional customer information is required in the pay request.
</Info>

Combine the order reference and `paymentoption`. Encrypt the request before sending it to the pay order [endpoint](/api-reference/orders/pay).

<CodeGroup>
  ```json Example (Unencrypted) theme={null}
  {
      "reference": "EPCLB-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "paymentoption": "PAYID"
  }
  ```

  ```json Example (Encrypted) theme={null}
  {
    "data": "B9pQJ1HoxybgfjNnEro+26w7lQZ6jriF3AFiUeGH2Ggacn6cF0srUlqiHEXeEncJcMw6ThDobjuS+AsmvhNfvGPGMddjbt5rcK2JrUnUI4cHk0XebJKoNnjEqivcyq0UKEMdYOLd6mYZtvKu5FMlpz0Lo0aMY49pnYvUGLSsCf/wOhlPx9PHgQDXptT+WBJcO3lzeD8O0S4IVSWPCWPLi7GhGlqhZpheEi1FHq39TCHk12hL3sqkkIktZIkkQVAe8AkwZGhy/CMJZrTzU6IXZr2ulT7mJenZljSk66m0pARcUqwMw/+5PEPECDo8SX3IkX2hmym02pGuWZeHE9ONWcaW7h8UIroQ/+kThz/RtP/UMiK3596cij66JcW+RcXKPiqNKysskcnaOlQFIFuhEiAczimLgd320RrQzehaw1C33UGsCzAG1p2EnDthjTF63BZtEhVlu9kN7qtFCz9AvojZeaZFKOxpJJ0usfwl9Hq5oAa56AFt/3IIsvqrAktTOyMgQ/jGQ6uhRYpA6UAH0CcYyv7L99hgVtRTXAxA/rpCtY7aTR9Pjxb5Lt1IV0Q1V8fWxAv0yY+ss07qeiSIsccsdJiN4LaMx3RvmDlu54XF68w51L34hOCDj/NBoPVUZrSaCJK2GPJ6CjOHI8q2/U2TkU+y+a80XCAC/rgqGhw="
  }
  ```
</CodeGroup>

Upon receiving your request, EPayClub returns a response containing a `redirectUrl` pointing to the PayID-hosted payment page.

```json 200 OK [expandable] theme={null}
{
    "data": {
        "paymentDetail": {
            "redirectUrl": "https://checkout.t365.io/payid?orderId=EPCLB-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "recipientAccount": null,
            "paymentReference": "EPCLB-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        "bankTransferDetails": null,
        "orderPayment": {
            "orderId": 31254,
            "orderPaymentReference": "PGW-PAYREF-C2EDFD88FCE74E89A9C7CC14B34181E8",
            "currency": "AUD",
            "statusId": 2,
            "orderPaymentResponseCode": "02",
            "orderPaymentResponseMessage": "pending-authentication",
            "orderPaymentInstrument": null,
            "remarks": "Order initiated and created successfully",
            "totalAmount": 100.00,
            "fee": 0.00
        }
    },
    "status": "success",
    "statusCode": "02",
    "message": "pending-authentication"
}
```

### Completing the Payment

Redirect the customer to `paymentDetail.redirectUrl`. The hosted page displays the PayID details and instructions for the customer to complete the bank transfer from their banking app.

The customer opens their banking app, selects **Pay to PayID**, and enters the displayed PayID to initiate the transfer. Once the payment is received and confirmed, EPayClub notifies you via webhook with the final transaction status.

<Info>
  PayID payments typically confirm within seconds on the NPP network, but may take up to a few minutes depending on the customer's bank.
</Info>

### Verifying the Payment

<Info>
  [Read](/orders/verify-orders) the transaction verification section to learn how to verify your PayID transactions.
</Info>

## Testing your integration

<Warning>
  Kindly [contact](mailto:support@epayclub.com) the support team to enable PayID testing on your account.
</Warning>

Follow these guidelines to successfully test your PayID integration:

1. Use an **AUD** order currency when creating the order — PayID is only available for AUD transactions.
2. Set the customer's country to `AU` on the order.
3. Use the test credentials provided by the support team to complete a payment on the hosted page.
4. Verify the final transaction status using the [order verification](/orders/verify-orders) endpoint or by checking the webhook payload delivered to your configured webhook URL.