Fetch a Payment Link

Overview

Retrieve the details of a previously created Payment Link. Use this endpoint to check the status of a payment link, view its configuration, and access the payment URL.

Resource Access

• User Permissions: All users can access this endpoint
• Endpoint: GET /payment_links/\{payment_link_id}

Arguments

Parameter	Type	Required	Description
payment_link_id	string	Yes	The unique ID of the Payment Link to retrieve

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/payment_links/PLpaymentLinkExample456' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response

{
  "id": "PLpaymentLinkExample456",
  "created_at": "2023-06-15T10:30:00Z",
  "updated_at": "2023-06-15T10:30:00Z",
  "link_url": "https://forms.finix.com/payment-links/PLpaymentLinkExample456",
  "link_expires_at": "2023-12-15T10:30:00Z",
  "merchant_id": "MUmerchantExample123",
  "application_id": "APapplicationExample123",
  "nickname": "Invoice #12345",
  "payment_frequency": "ONE_TIME",
  "is_multiple_use": false,
  "state": "ACTIVE",
  "allowed_payment_methods": ["PAYMENT_CARD", "BANK_ACCOUNT"],
  "amount_details": {
    "amount_type": "FIXED",
    "total_amount": 50000,
    "currency": "USD",
    "amount_breakdown": {
      "subtotal_amount": 45000,
      "shipping_amount": 3000,
      "estimated_tax_amount": 2000,
      "discount_amount": 0,
      "tip_amount": 0
    }
  },
  "items": [
    {
      "name": "Premium Widget",
      "quantity": 2,
      "description": "High-quality widget with lifetime warranty",
      "price_details": {
        "sale_amount": 22500,
        "currency": "USD"
      },
      "image_details": {
        "primary_image_url": "https://example.com/images/widget.jpg"
      }
    }
  ],
  "additional_details": {
    "collect_name": true,
    "collect_email": true,
    "collect_billing_address": true,
    "success_return_url": "https://yourstore.com/thank-you",
    "send_receipt": true,
    "receipt_requested_delivery_methods": [
      {
        "type": "EMAIL",
        "destinations": ["customer@example.com"]
      }
    ]
  },
  "branding": {
    "brand_color": "#111823",
    "accent_color": "#f3eeee",
    "logo": "https://yourstore.com/logo.png",
    "logo_alternative_text": "Your Store Logo",
    "button_font_color": "#ffffff"
  },
  "split_transfers": [],
  "tags": {
    "invoice_number": "12345",
    "customer_id": "CUST-789"
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/payment_links/PLpaymentLinkExample456"
    },
    "merchant": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample123"
    },
    "transfers": {
      "href": "https://api.ahrvo.network/payments/na/payment_links/PLpaymentLinkExample456/transfers"
    }
  }
}

Additional Information

• Link URL: The link_url field contains the publicly accessible URL to share with customers for payment
• Link States:
  • ACTIVE: Link is live and can accept payments
  • DEACTIVATED: Link has been manually deactivated and cannot accept payments
  • COMPLETED: Single-use link has been paid (when is_multiple_use = false)
  • EXPIRED: Link has passed its expiration date
• Link Expiration: The link_expires_at field shows when the link will automatically expire (default: 6 months from creation)
• Payment Frequency:
  • ONE_TIME: Link is for a single payment
  • RECURRING: Link is for recurring subscription payments
• Multiple Use: When is_multiple_use is true, the link remains ACTIVE after payment and can be reused
• Amount Configuration:
  • amount_type: FIXED (exact amount) or MIN_MAX (customer chooses within range)
  • total_amount: Total payment amount in cents
  • amount_breakdown: Optional itemization showing subtotal, tax, shipping, discounts, tips, etc.
• Items: Line items displayed on the hosted payment page with names, quantities, prices, and images
• Data Collection Settings:
  • collect_name: Whether to collect customer name
  • collect_email: Whether to collect email address
  • collect_billing_address: Whether to collect billing address for AVS verification
• Success Redirect: The success_return_url defines where customers are redirected after successful payment
• Receipt Delivery: Configure automatic receipt sending via email or SMS after payment
• Branding: Customize the payment page appearance with your brand colors, logo, and styling
• Split Transfers: Configuration for automatically splitting payments among multiple merchants
• Related Resources: Use the _links object to navigate to:
  • Associated merchant and application
  • Transfers created through this payment link
• Sharing the Link: Send the link_url to customers via:
  • Email invoices
  • SMS messages
  • QR codes
  • Embedded on your website
  • Social media