List all payment links - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Example

{
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string",
    "active": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/payment_links' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string",
    "active": true
}'

Responses

🟢200OK

application/json

Body

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "active": true,
            "after_completion": {
                "type": "redirect",
                "hosted_confirmation": {
                    "custom_message": "string"
                },
                "redirect": {
                    "url": "string"
                }
            },
            "billing_address_collection": "auto",
            "currency": "string",
            "livemode": true,
            "metadata": {},
            "phone_number_collection": {
                "enabled": true
            },
            "shipping_address_collection": {
                "allowed_countries": [
                    "string"
                ]
            },
            "url": "string",
            "line_items": {
                "object": "\"list\"",
                "url": "string",
                "has_more": true,
                "data": [
                    {
                        "id": "string",
                        "object": "string",
                        "amount_subtotal": "string",
                        "amount_total": "string",
                        "currency": "string",
                        "description": "string",
                        "price": {
                            "id": "string",
                            "object": "string",
                            "active": true,
                            "billing_scheme": "per_unit",
                            "created": 0,
                            "currency": "string",
                            "livemode": true,
                            "lookup_key": "string",
                            "metadata": {},
                            "nickname": "string",
                            "product": "string",
                            "type": "one_time",
                            "unit_amount": 0,
                            "recurring": {
                                "interval": "day",
                                "interval_count": 0,
                                "usage_type": "licensed"
                            },
                            "tiers": [
                                {
                                    "up_to": "string",
                                    "flat_amount": "string",
                                    "unit_amount": "string"
                                }
                            ]
                        },
                        "quantity": "string"
                    }
                ]
            },
            "created": 0
        }
    ]
}