List all payment links
GET/v1/links
Returns a list of your payment links.
Request
Query Parameters
The page number to return.
The number of items to return per page.
Possible values: [active, deactivated]
The status of the Payment Requests to return.
Responses
- 200
- 400
Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
The total number of Payment Links.
The URL for the previous page of Payment Links.
The URL for the next page of Payment Links.
The number of Payment Links returned in this response.
data
ReadLink[]
An array of Payment Links.
The unique identifier of the Payment Link.
String representing the object's type. Objects of the same type share the same value.
Has the value of true if the Payment Link is accessible or false otherwise.
Has the value of true if the quantity of the line items can be adjusted by the customer or false otherwise.
branding
object
Details on branding elements to apply when rendering the Payment Link page.
A secure URL to an image icon
A secure URL to an image logo
Has the value of true if logo should be rendered in payment page or false if icon should be used.
A hex color code that will be used as background color of the Payment Link page
A hex color code that will be used as color of the submit button and links
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
A description for the Payment Link.
The date when the Payment Link will automatically expire. The format is MM/DD/YYYY.
A reference name for the Payment Link that is only visible to the merchant for easy identification.
line_items
LineItem[]
A list of line items that will be displayed in the Payment Link page.
Unit amount of the product in cents represented as a whole integer.
A description of the product
A secure URL to an image of the product
The name of the product
The total number of stocks for the product
The total number of stocks remaining for the product
Has the value of true if the object exists in live mode or the value of false if the object exists in test mode.
The maximum number of payments that can be made to the Payment Link.
metadata
object
A set of key-value pairs that you can attach to the Payment Link. It can be used to store additional information about the Payment Link.
Possible values: [card, bpi, gcash, paymaya, alipay, unionpay, wechat]
The payment methods that are available for the customer to pay the Payment Link.
Describes whether to collect the customer's phone number at Checkout.
The URL to redirect the customer to after the payment is successful.
Default value: true
Indicates whether 3D Secure authentication shall be required for card payments. Always have a value true.
Time at which the object was last updated. Measured in seconds since the Unix epoch.
The URL of the Payment Link.
{
"total": 100,
"previous": null,
"next": "https://buy.zip.ph/api/v1/links?page=2",
"count": 10,
"data": [
{
"id": "plink_215NRW1v1Gg847dx",
"object": "string",
"active": true,
"allow_adjustable_quantity": true,
"branding": {
"icon": "https://example.com/icon.png",
"logo": "https://example.com/logo.png",
"use_logo": true,
"primary_color": "#FFFFFF",
"secondary_color": "#4f99fe"
},
"created": 1635779916046,
"currency": "PHP",
"description": null,
"expiry": "12/31/2022",
"internal_name": "12.12 Mega Sale",
"line_items": [
{
"amount": 999,
"description": "Charcoal, Large",
"image": "https://example.com/image.png",
"name": "Zip Mens Shirt",
"quantity": 20,
"remaining": 10
}
],
"livemode": true,
"maximum_payments": null,
"metadata": {},
"payment_method_types": [
"card",
"gcash",
"paymaya"
],
"phone_number_collection": true,
"redirect_url": null,
"require_auth": true,
"updated": 1635779916046,
"url": "https://buy.zip.ph/gW0550U"
}
]
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
error
object
{
"message": "Missing parameter: currency",
"error": {
"type": "invalid_request_error",
"message": "Missing parameter: currency"
}
}