---
updatedAt: 2025-11-12T23:45:21.000Z
agentTools:
  projectIndex: https://docs.fazz.com/llms.txt
---

# Payment Links

The Payment Link object represents the life cycle of a pre-built payment page from the time it was requested to the completion of the payment.

***

### Payment Link attributes

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Attributes
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        id
      </td>

      <td>
        string
      </td>

      <td>
        Unique identifier for the object.
      </td>
    </tr>

    <tr>
      <td>
        status
      </td>

      <td>
        enum
      </td>

      <td>
        The status of the Payment Link. See [Payment Link Statuses](https://docs.fazz.com/docs/payment-link-statuses)
      </td>
    </tr>

    <tr>
      <td>
        amount
      </td>

      <td>
        string
      </td>

      <td>
        The payment amount to be received.
      </td>
    </tr>

    <tr>
      <td>
        referenceId
      </td>

      <td>
        string
      </td>

      <td>
        The referenceId that was used to request for the Payment Link. Typically an "order id", "invoice id" or "cart id".
      </td>
    </tr>

    <tr>
      <td>
        createdAt
      </td>

      <td>
        timestamp
      </td>

      <td>
        Time at which the object was created.
      </td>
    </tr>

    <tr>
      <td>
        description
      </td>

      <td>
        string
      </td>

      <td>
        An arbitrary string attached to the object. Often useful for displaying to users.
      </td>
    </tr>

    <tr>
      <td>
        expiredAt
      </td>

      <td>
        timestamp
      </td>

      <td>
        Time at which the Payment Link object should no longer be able to successfully receive any payments.
      </td>
    </tr>

    <tr>
      <td>
        paymentLinkUrl
      </td>

      <td>
        string
      </td>

      <td>
        A url for payment page that your customer need to open to see payment details and instructions.
      </td>
    </tr>

    <tr>
      <td>
        customerName
      </td>

      <td>
        string
      </td>

      <td>
        Your customer name.
      </td>
    </tr>

    <tr>
      <td>
        customerEmail
      </td>

      <td>
        string
      </td>

      <td>
        Your customer email.
      </td>
    </tr>

    <tr>
      <td>
        customerPhoneNumber
      </td>

      <td>
        string
      </td>

      <td>
        Your customer phone number.
      </td>
    </tr>

    <tr>
      <td>
        paymentMethodOptions
      </td>

      <td>
        object
      </td>

      <td>
        Only support displayName param at the moment.
      </td>
    </tr>

    <tr>
      <td>
        displayName
      </td>

      <td>
        string
      </td>

      <td>
        This is the display name that will show up on the online bank transfer or ATM screen.
      </td>
    </tr>
  </tbody>
</Table>

### Payment Link object

```json Payment Link Object
{
    "data": {
        "id": "paymentlink_fd65953f01a9de1364fe899d2722f255",
        "type": "payment_links",
        "attributes": {
            "status": "pending",
            "amount": "10000.0",
            "referenceId": "Payment_link_test_reference_id",
            "createdAt": "2021-12-06 00:10:34 +0700",
            "description": "Order Number 0001",
            "expiredAt": "2021-12-06 16:00:00 +0700",
            "paymentLinkUrl": "https://id-payment-link.xfers.com/paymentlink_ca36f8e4953d91d6b26b4ca49d6d17b1",
            "customerName": "John Doe",
            "customerEmail": "john.doe@xfers.com",
            "customerPhoneNumber": "080000000000",
            "paymentMethodOptions": {
              "displayName": "Nama Tampilan"
            }
        }
    }
}
```