Skip to main content

List all Payment Requests

GET 
/v1/requests

Returns a list of all Payment Requests.

Request​

Query Parameters

    page integer

    The page number to return.

    limit integer

    The number of items to return per page.

    status string

    Possible values: [open, paid, voided]

    The status of the Payment Requests to return.

    Example: paid

Responses​

Successful response

Schema

    total integer

    The total number of Payment Requests.

    previous stringnullable

    The URL for the previous page of Payment Requests.

    next stringnullable

    The URL for the next page of Payment Requests.

    count integer

    The number of Payment Requests returned in this response.

    data

    ReadRequestSerializer[]

    An array of Payment Requests.

  • Array [

    • id string

    The unique identifier of the Payment Request.

    object string

    String representing the object's type. Objects of the same type share the same value.

    account_name string

    The name of the merchant who created the Payment Request.

    account_support_email stringnullable

    The support email of the merchant who created the Payment Request.

    branding

    object

    Details on branding elements to apply when rendering the Payment Request page.

    icon stringnullable

    A secure URL to an image icon

    logo stringnullable

    A secure URL to an image logo

    use_logo boolean

    Has the value of true if logo should be rendered in payment page or false if icon should be used.

    primary_color stringnullable

    A hex color code that will be used as background color of the Payment Request page

    secondary_color stringnullable

    A hex color code that will be used as background color of the submit or PAY button

    created timestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    customer string

    The ID of the customer who will receive the Payment Request.

    customer_name string

    The name of the customer .

    customer_phone stringnullable

    The phone number of the customer.

    delivery_methods string[]

    The methods by which the customer will receive the Payment Request.

    delivered

    object

    Indicates the status whether the Payment Request has been delivered to the customer.

    email boolean

    Indicates the status whether the Payment Request has been delivered to the customer via email.

    sms boolean

    Indicates the status whether the Payment Request has been delivered to the customer via SMS.

    line_items

    LineItemSerializer[]

    A list of items the customer will be billed for.

  • Array [

    • amount integerrequired

    Unit amount of the product in cents represented as a whole integer.

    description stringnullable

    A description of the product

    image stringnullable

    A secure URL to an image of the product

    name stringrequired

    The name of the product

    quantity integerrequired

    The quantity of the products being purchased

  • ]

    • livemode boolean

    Has the value of true if the object exists in live mode or the value of false if the object exists in test mode.

    message stringnullable

    A custom message to be included in the Payment Request.

    metadata

    object

    A set of key-value pairs that you can attach to the Payment Request. It can be useful for storing additional information about the invoice in a structured format.

    property name* string
    number string

    A unique, identifying string that follows a specific pattern. It is used to identify the Payment Request associated to a customer.

    paid boolean

    Indicates the status whether the Payment Request has been paid by the customer.

    paid_at timestampnullable

    Time at which the Payment Request was paid. Measured in seconds since the Unix epoch.

    payment_details objectnullable

    The charge object details associated with the Payment Request after successful payment.

    payment_method_types PaymentMethodType (string)[]

    Possible values: [card, bpi, gcash, paymaya, alipay, unionpay, wechat]

    The payment methods that are available for the customer to pay the Payment Request.

    payment_request_url string

    The URL where the customer can view and pay the Payment Request.

    require_auth boolean

    Default value: true

    Indicates whether 3D Secure authentication shall be required for card payments. Always have a value true.

    subtotal integer

    The total amount of the Payment Request before any discounts or taxes are applied.

    total integer

    The total amount of the Payment Request after any discounts or taxes are applied.

    updated timestamp

    Time at which the object was last updated. Measured in seconds since the Unix epoch.

    voided boolean

    Indicates the status whether the Payment Request has been voided by the merchant.

    voided_at timestampnullable

    Time at which the Payment Request was voided. Measured in seconds since the Unix epoch.

    void_reason stringnullable

    The reason provided by the Merchant why the Payment Request was voided.

  • ]

Loading...