WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payment Links
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
      POST
    • Update a payment link
      POST
    • Retrieve payment link
      GET
    • List all payment links
      GET
    • Retrieve a payment link's line items
      GET
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Payment Links

Retrieve payment link

GET
/v1/payment_links/{id}
Retrieves payment link

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 *****************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apitest.wooshpay.com/v1/payment_links/' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, like 'plink_xxxx'.
object
string 
optional
"payment_link"
active
boolean 
optional
Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.
after_completion
object 
optional
Behavior after the purchase is complete.
type
enum<string> 
optional
The specified behavior after the purchase is complete.
Allowed values:
redirecthosted_confirmation
hosted_confirmation
object 
optional
Configuration when type=hosted_confirmation.
redirect
object 
optional
Configuration when type=redirect.
billing_address_collection
enum<string> 
optional
Configuration for collecting the customer’s billing address.
Allowed values:
autorequired
currency
string 
optional
Three-letter ISO currency code. Must be a supported currency.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
phone_number_collection
object 
optional
Controls phone number collection settings during checkout.
enabled
boolean 
optional
If true, a phone number will be collected during checkout.
shipping_address_collection
object 
optional
Configuration for collecting the customer’s shipping address.
allowed_countries
array[string]
optional
An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.
url
string 
optional
The public URL that can be shared with customers.
line_items
object 
optional
The line items representing what is being sold. This field is not included by default. This field is not included by default. To include it in the response, expand the line_items field.
object
string 
optional
Default:
"list"
url
string 
optional
has_more
boolean 
optional
data
array [object {8}] 
optional
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
Example
{
  "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
}
Previous
Update a payment link
Next
List all payment links
Built with