{
    "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": "[email protected]",
            "customerPhoneNumber": "080000000000",
            "paymentMethodOptions": {
              "displayName": "Nama Tampilan"
            }
        }
    }
}

Attributes

Type

Description

id

string

Unique identifier for the object.

status

enum

The status of the Payment Link. See Payment Link Statuses

amount

string

The payment amount to be received.

referenceId

string

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

createdAt

timestamp

Time at which the object was created.

description

string

An arbitrary string attached to the object. Often useful for displaying to users.

expiredAt

timestamp

Time at which the Payment Link object should no longer be able to successfully receive any payments.

paymentLinkUrl

string

An url for payment page that your customer need to open to see payment details and instructions.

customerName

string

Your customer name.

customerEmail

string

Your customer email.

customerPhoneNumber

string

Your customer phone number.

paymentMethodOptions

object

Only support displayName param at the moment.

displayName

string

This is the display name that will show up on the online bank transfer or ATM screen.