In a rush? Schedule an Appointment
    Fetching local time...
    Anytime Capital

    Get started

    • Overview
    • Quickstart
    • Pricing
    • Support

    Accept payments

    • Checkout & website
    • In person (QR)
    • Payment methods
    • Fraud rules & 3D Secure

    Get paid out

    • Payout options

    API reference

    • Authentication
    • Errors
    • Pagination
    • Idempotency
    • Rate limits
    • Payment links
    • Invoices
    • Customers
    • Payments
    • Webhooks

    Build with AI

    • MCP server & AI tools

    FAQ

    • FAQ

    For AI tools

    • llms-full.txt
    • MCP server
    Docs menu · Payment links

    Get started

    • Overview
    • Quickstart
    • Pricing
    • Support

    Accept payments

    • Checkout & website
    • In person (QR)
    • Payment methods
    • Fraud rules & 3D Secure

    Get paid out

    • Payout options

    API reference

    • Authentication
    • Errors
    • Pagination
    • Idempotency
    • Rate limits
    • Payment links
    • Invoices
    • Customers
    • Payments
    • Webhooks

    Build with AI

    • MCP server & AI tools

    FAQ

    • FAQ

    For AI tools

    • llms-full.txt
    • MCP server
    DocsAPI referencePayment links

    Payment links API

    Create, list, retrieve, update and deactivate hosted payment links with the Anytime Capital Payments API, and prefill checkout from the link's URL.

    View as MarkdownOpen in Claude

    A payment link is a hosted checkout page for one price. Share its url by text, email, DM or QR code, put it behind a button on your site, or create one per order from your backend and send the customer straight to it. Customers pay by card, Apple Pay or Google Pay, and by bank account where you have turned it on.

    Links made for invoices and subscription plans are managed with those and don't appear here.

    The payment link object

    JSON
    {
      "object": "payment_link",
      "id": "pl_4kTz8QwN2xYb6RcD1mPa",
      "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
      "title": "Consulting — October",
      "description": "Two strategy sessions",
      "amountCents": 12500,
      "currency": "usd",
      "active": true,
      "singleUse": false,
      "shippingCents": 0,
      "collectShipping": false,
      "allowDiscountCodes": false,
      "successUrl": null,
      "confirmationMessage": "Thanks! We'll email your session times within a day.",
      "requireTermsConsent": false,
      "metadata": {
        "campaign": "fall-launch"
      },
      "items": [],
      "createdAt": "2026-10-01T09:30:00.000Z",
      "deactivatedAt": null,
      "allowQuantity": false,
      "maxQuantity": null,
      "customFields": [],
      "tipsEnabled": false,
      "payWhatYouWant": false,
      "minAmountCents": null
    }
    FieldTypeDescription
    idstringpl_ followed by 20 letters and digits.
    urlstringThe pay page. Share it, redirect to it or embed it.
    title, descriptionstringWhat the customer sees at the top of checkout.
    amountCentsintegerThe price in cents. With payWhatYouWant, the suggested amount.
    currencystringusd.
    activebooleanFalse once the link is deactivated (deactivatedAt is set).
    singleUsebooleanThe link closes after its first successful payment.
    shippingCents, collectShippinginteger, booleanFlat shipping added to each payment; whether a shipping address is asked for.
    allowDiscountCodesbooleanCustomers may enter one of your discount codes.
    successUrl, confirmationMessagestring or nullWhere customers go, or what they read, after paying. A link has at most one of them.
    requireTermsConsentbooleanCustomers must agree to your terms before paying.
    metadataobjectYour own key/value pairs, copied onto each payment made on the link.
    itemsarrayCatalog products, for links made in the dashboard from products. Empty for single-price links.
    allowQuantity, maxQuantityboolean, integer or nullCustomers choose how many, up to maxQuantity.
    customFieldsarrayQuestions asked at checkout.
    tipsEnabledbooleanA tip is offered at checkout.
    payWhatYouWant, minAmountCentsboolean, integer or nullCustomers choose the amount, at least minAmountCents.
    createdAt, deactivatedAtstring, string or nullISO 8601 times in UTC.

    Endpoints

    List payment links

    GET/api/v1/payment-links

    Your payment links, newest first, each with the choices it offers the buyer.

    Query

    active
    boolean
    true for links taking payments, false for deactivated ones.
    limit
    integer
    How many objects per page. See Pagination.
    cursor
    string
    The previous page's nextCursor, for the page after it.
    Request
    curl "https://anytime-capital.com/api/v1/payment-links?active=true&limit=10" \
      -H "Authorization: Bearer $ANYTIME_API_KEY"
    Response 200
    {
      "object": "list",
      "data": [
        {
          "object": "payment_link",
          "id": "pl_4kTz8QwN2xYb6RcD1mPa",
          "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
          "title": "Consulting — October",
          "description": "Two strategy sessions",
          "amountCents": 12500,
          "currency": "usd",
          "active": true,
          "singleUse": false,
          "shippingCents": 0,
          "collectShipping": false,
          "allowDiscountCodes": false,
          "successUrl": null,
          "confirmationMessage": "Thanks! We'll email your session times within a day.",
          "requireTermsConsent": false,
          "metadata": {
            "campaign": "fall-launch"
          },
          "items": [],
          "createdAt": "2026-10-01T09:30:00.000Z",
          "deactivatedAt": null,
          "allowQuantity": false,
          "maxQuantity": null,
          "customFields": [],
          "tipsEnabled": false,
          "payWhatYouWant": false,
          "minAmountCents": null
        }
      ],
      "hasMore": false,
      "nextCursor": null
    }

    Create a payment link

    POST/api/v1/payment-links

    Creates a single-price link and answers 201 with it. Supports Idempotency-Key.

    Body

    title
    stringrequired
    What the customer is paying for, up to 120 characters.
    amountCents
    integerrequired
    The price, from 100 ($1.00) to 1000000 ($10,000.00).
    description
    string
    Shown under the title, up to 500 characters.
    singleUse
    boolean
    Close the link after its first successful payment. Use it for one link per order. Default false.
    shippingCents
    integer
    Flat shipping added to each payment, up to $1,000.00. Default 0.
    collectShipping
    boolean
    Ask for a shipping address. Default false.
    allowDiscountCodes
    boolean
    Let customers enter one of your discount codes. Default false.
    successUrl
    string
    An https:// page on your site to send customers to after paying. Not with confirmationMessage.
    confirmationMessage
    string
    Up to 500 characters shown on our confirmation page after paying, instead of a successUrl.
    requireTermsConsent
    boolean
    Customers must tick “I agree to the terms” before paying. Needs a terms link in Settings → Payments (409 TERMS_URL_REQUIRED otherwise). Default false.
    metadata
    object
    Up to 20 of your own key/value pairs, e.g. {"orderId": "1042"}. Keys: up to 40 letters, numbers, - and _; values: text up to 500 characters. Copied onto each payment; customers never see it.
    allowQuantity
    boolean
    Let customers choose how many. Default false.
    maxQuantity
    integer
    With allowQuantity: the most per payment, 1–99. Default 10.
    tipsEnabled
    boolean
    Offer a tip (10%, 15%, 20% or an amount). Default false.
    payWhatYouWant
    boolean
    Customers choose the amount; amountCents is the suggestion. Not with quantity, tips or discount codes. Default false.
    minAmountCents
    integer
    With payWhatYouWant: the smallest amount. Default 100.
    customFields
    array
    Up to 3 checkout questions: { id, label, type, options, required } with a label up to 60 characters, type one of text, long_text, phone or dropdown, and 2–10 options for a dropdown.

    Headers

    Idempotency-Key
    string
    Recommended. See Idempotency.
    Request
    curl -X POST https://anytime-capital.com/api/v1/payment-links \
      -H "Authorization: Bearer $ANYTIME_API_KEY" \
      -H "Idempotency-Key: order-1042-link" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Consulting — October",
        "description": "Two strategy sessions",
        "amountCents": 12500,
        "metadata": { "campaign": "fall-launch" }
      }'
    Response 201
    {
      "object": "payment_link",
      "id": "pl_4kTz8QwN2xYb6RcD1mPa",
      "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
      "title": "Consulting — October",
      "description": "Two strategy sessions",
      "amountCents": 12500,
      "currency": "usd",
      "active": true,
      "singleUse": false,
      "shippingCents": 0,
      "collectShipping": false,
      "allowDiscountCodes": false,
      "successUrl": null,
      "confirmationMessage": "Thanks! We'll email your session times within a day.",
      "requireTermsConsent": false,
      "metadata": {
        "campaign": "fall-launch"
      },
      "items": [],
      "createdAt": "2026-10-01T09:30:00.000Z",
      "deactivatedAt": null,
      "allowQuantity": false,
      "maxQuantity": null,
      "customFields": [],
      "tipsEnabled": false,
      "payWhatYouWant": false,
      "minAmountCents": null
    }

    Catalog products (items) can't be sent through the API yet: send amountCents for a single price. Links built from products in the dashboard still list and retrieve with their items.

    Retrieve a payment link

    GET/api/v1/payment-links/{id}

    Returns the link, or 404 NOT_FOUND if it isn't one of yours.

    Request
    curl https://anytime-capital.com/api/v1/payment-links/pl_4kTz8QwN2xYb6RcD1mPa \
      -H "Authorization: Bearer $ANYTIME_API_KEY"
    Response 200
    {
      "object": "payment_link",
      "id": "pl_4kTz8QwN2xYb6RcD1mPa",
      "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
      "title": "Consulting — October",
      "description": "Two strategy sessions",
      "amountCents": 12500,
      "currency": "usd",
      "active": true,
      "singleUse": false,
      "shippingCents": 0,
      "collectShipping": false,
      "allowDiscountCodes": false,
      "successUrl": null,
      "confirmationMessage": "Thanks! We'll email your session times within a day.",
      "requireTermsConsent": false,
      "metadata": {
        "campaign": "fall-launch"
      },
      "items": [],
      "createdAt": "2026-10-01T09:30:00.000Z",
      "deactivatedAt": null,
      "allowQuantity": false,
      "maxQuantity": null,
      "customFields": [],
      "tipsEnabled": false,
      "payWhatYouWant": false,
      "minAmountCents": null
    }

    Update a payment link

    POST/api/v1/payment-links/{id}

    Send only what changes; everything else stays as it is. Changes apply to the link straight away; payments already made keep what they were charged. Supports Idempotency-Key.

    Body

    title, description
    string
    As on create. A null description removes it.
    successUrl, confirmationMessage
    string or null
    What customers see after paying. Setting one clears the other; null clears it.
    requireTermsConsent
    boolean
    Turning it on needs a terms link in Settings → Payments.
    metadata
    object or null
    Replaces all of the link's metadata; null or {} clears it.
    customFields
    array
    Replaces the link's checkout questions; [] removes them.
    tipsEnabled, allowQuantity, maxQuantity, collectShipping
    boolean / integer
    As on create. Quantity and tips stay off on a link where customers choose the amount.
    Request
    curl -X POST https://anytime-capital.com/api/v1/payment-links/pl_4kTz8QwN2xYb6RcD1mPa \
      -H "Authorization: Bearer $ANYTIME_API_KEY" \
      -H "Idempotency-Key: 1d2c4b6a-update-title" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Consulting — November",
        "metadata": { "campaign": "winter" }
      }'
    Response 200
    {
      "object": "payment_link",
      "id": "pl_4kTz8QwN2xYb6RcD1mPa",
      "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
      "title": "Consulting — November",
      "description": "Two strategy sessions",
      "amountCents": 12500,
      "currency": "usd",
      "active": true,
      "singleUse": false,
      "shippingCents": 0,
      "collectShipping": false,
      "allowDiscountCodes": false,
      "successUrl": null,
      "confirmationMessage": "Thanks! We'll email your session times within a day.",
      "requireTermsConsent": false,
      "metadata": {
        "campaign": "winter"
      },
      "items": [],
      "createdAt": "2026-10-01T09:30:00.000Z",
      "deactivatedAt": null,
      "allowQuantity": false,
      "maxQuantity": null,
      "customFields": [],
      "tipsEnabled": false,
      "payWhatYouWant": false,
      "minAmountCents": null
    }

    The price is fixed once a link exists: amountCents, items, payWhatYouWant, minAmountCents, shippingCents, allowDiscountCodes and singleUse answer 400 NOT_EDITABLE. Create a new link to sell at a new price, and deactivate the old one.

    Deactivate a payment link

    POST/api/v1/payment-links/{id}/deactivate

    The link stops taking payments; anyone who opens it sees that it's closed. Payments already made are unaffected. Deactivating a link that is already off returns it unchanged. Supports Idempotency-Key.

    Request
    curl -X POST https://anytime-capital.com/api/v1/payment-links/pl_4kTz8QwN2xYb6RcD1mPa/deactivate \
      -H "Authorization: Bearer $ANYTIME_API_KEY" \
      -H "Idempotency-Key: deactivate-pl_4kTz8Q"
    Response 200
    {
      "object": "payment_link",
      "id": "pl_4kTz8QwN2xYb6RcD1mPa",
      "url": "https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa",
      "title": "Consulting — October",
      "description": "Two strategy sessions",
      "amountCents": 12500,
      "currency": "usd",
      "active": false,
      "singleUse": false,
      "shippingCents": 0,
      "collectShipping": false,
      "allowDiscountCodes": false,
      "successUrl": null,
      "confirmationMessage": "Thanks! We'll email your session times within a day.",
      "requireTermsConsent": false,
      "metadata": {
        "campaign": "fall-launch"
      },
      "items": [],
      "createdAt": "2026-10-01T09:30:00.000Z",
      "deactivatedAt": "2026-10-16T10:00:00.000Z",
      "allowQuantity": false,
      "maxQuantity": null,
      "customFields": [],
      "tipsEnabled": false,
      "payWhatYouWant": false,
      "minAmountCents": null
    }

    Prefill checkout

    Fill in details for your customer by adding parameters to a link's url. A value that isn't valid is ignored, never an error.

    ParameterWhat it does
    prefilled_emailThe customer's email for their receipt. They can still change it.
    codeOne of your discount codes, applied when checkout opens, on links that accept codes.
    refYour own reference for the payment, up to 200 letters, numbers, spaces and _ . : / # @ + -. Stored on the payment as clientReference and returned by the API and in webhooks.
    Text
    https://anytime-capital.com/pay/business/pl_4kTz8QwN2xYb6RcD1mPa?prefilled_email=jordan%40example.com&code=FALL20&ref=order_1042

    On your own website, the Pay button and the inline checkout take the same values as data-email, data-code and data-ref. See Checkout.

    One link per order

    For a cart or an order whose total you work out yourself, create a singleUse link per order with the order id in metadata, send the customer to its url, and mark the order paid when the payment.succeeded webhook arrives: data.metadata carries your order id and data.source.id the link id. Use a stored Idempotency-Key so a retry never makes a second link. For a fixed price you sell again and again, one reusable link with ?ref= per customer does the same job.

    PreviousRate limitsNext Invoices

    Anytime Capital is a fintech company, not a bank. Payment processing, banking and payout services are provided by Anytime Capital's licensed partners. Rates shown are for US card payments; international cards, currency conversion and disputes may carry additional fees shown in your dashboard before you accept a payment.

    On this page

    • The payment link object
    • Endpoints
    • List payment links
    • Create a payment link
    • Retrieve a payment link
    • Update a payment link
    • Deactivate a payment link
    • Prefill checkout
    • One link per order
    Anytime Capital
    (470) 748-2530
    App Store

    Business

    • Business Checking
    • Business Debit Cards
    • Payments
    • Pricing
    • In-Person Payments
    • Invoicing
    • Global Payouts
    • Bill Pay
    • Expense Management
    • Developer Docs

    Solutions

    • CPAs & Accountants
    • Financial Advisors
    • Boat & Auto Dealerships
    • Dental & Medical Practices
    • Creators & Coaches
    • All solutions

    Crypto

    • Crypto Wallet
    • Tether Wallet
    • Buy Digital Assets
    • Explore Markets
    • Security & Licenses
    • Compare Platforms
    • Bitcoin ATM Alternative

    Company

    • Our Story
    • Schedule Appointment
    • Careers
    • Media & Press
    • Investor Relations
    • FAQ

    Branches

    • Atlanta, Georgia
    • Miami, Florida
    • Houston, Texas
    • All branches

    Legal

    • Terms & Conditions
    • Privacy Policy
    • Your Privacy Choices
    • Fraud Notice

    © 2026 Anytime Capital LLC. Anytime Capital is a fintech company, not a bank.

    The Anytime Capital Mastercard® Prepaid Card is issued by Pathward®, N.A., Member FDIC. Mastercard® is a registered trademark of Mastercard International Incorporated. All other trademarks and service marks belong to their respective owners.

    Mastercard