Create a Payment Link

Basic Request

curl -X POST https://api.yabetoo.com/v1/payment-links \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "amount",
    "name": "Invoice Payment",
    "amount": 25000,
    "currency": "XOF"
  }'

Required Parameters

Parameter	Type	Description
`type`	string	Link type: `product`, `amount`, or `subscription`
`name`	string	Link name (displayed to customer)
`currency`	string	Currency code (`XOF`, `EUR`, `USD`)

Optional Parameters

Parameter	Type	Description
`description`	string	Link description
`slug`	string	Custom slug for the URL
`amount`	number	Fixed amount (for `amount` type)
`minAmount`	number	Minimum amount (for variable amount)
`maxAmount`	number	Maximum amount (for variable amount)
`items`	array	Items to sell (for `product` type)
`expiresAt`	string	Expiration date (ISO 8601)
`maxRedemptions`	number	Maximum number of uses
`collectBillingAddress`	boolean	Collect billing address
`collectShippingAddress`	boolean	Collect shipping address
`allowPromotionCodes`	boolean	Allow promo codes
`successUrl`	string	Redirect URL after payment
`cancelUrl`	string	Redirect URL if cancelled
`brandingId`	string	Custom branding ID
`metadata`	object	Custom data

Link Types

Fixed Amount
Variable Amount
Products
Subscription

Type `amount` - Fixed Amount

To collect a specific amount:

{
  "type": "amount",
  "name": "Invoice #1234",
  "description": "Payment for your January invoice",
  "amount": 50000,
  "currency": "XOF"
}

Type `amount` - Variable Amount

Allow the customer to choose the amount (ideal for donations):

{
  "type": "amount",
  "name": "Make a Donation",
  "description": "Support our organization",
  "minAmount": 1000,
  "maxAmount": 1000000,
  "currency": "XOF"
}

If amount is omitted but minAmount and/or maxAmount are defined, the customer can enter any amount within the specified limits.

Type `product` - Product Sales

Sell products from your catalog:

{
  "type": "product",
  "name": "T-shirt Shop",
  "description": "Summer 2024 Collection",
  "currency": "XOF",
  "items": [
    {
      "productId": "prod_abc123",
      "priceId": "price_xyz789",
      "quantity": 1,
      "adjustableQuantity": true,
      "minQuantity": 1,
      "maxQuantity": 10
    },
    {
      "name": "Shipping Fee",
      "description": "Express delivery",
      "quantity": 1,
      "isOptional": false
    }
  ]
}

Type `subscription` - Recurring Subscription

Create a link that starts a subscription:

{
  "type": "subscription",
  "name": "Pro Subscription",
  "description": "Unlimited access to all features",
  "currency": "XOF",
  "items": [
    {
      "priceId": "price_recurring_monthly"
    }
  ]
}

For subscriptions, use a priceId associated with a recurring price.

Item Structure

For product and subscription types, you can define items:

Field	Type	Description
`productId`	string	Product ID (`prod_xxx`)
`priceId`	string	Price ID (`price_xxx`)
`name`	string	Custom name (if no product)
`description`	string	Custom description
`imageUrl`	string	Image URL
`quantity`	number	Default quantity (default: 1)
`adjustableQuantity`	boolean	Allow customer to modify quantity
`minQuantity`	number	Minimum quantity
`maxQuantity`	number	Maximum quantity
`isOptional`	boolean	Optional item (customer can remove it)
`sortOrder`	number	Display order

Advanced Options

Limit Usage

{
  "type": "amount",
  "name": "Limited Offer",
  "amount": 15000,
  "currency": "XOF",
  "maxRedemptions": 100,
  "expiresAt": "2024-12-31T23:59:59Z"
}

Collect Addresses

{
  "collectBillingAddress": true,
  "collectShippingAddress": true
}

{
  "allowPromotionCodes": true
}

Custom Redirect URLs

{
  "successUrl": "https://your-site.com/thank-you?link_id={PAYMENT_LINK_ID}",
  "cancelUrl": "https://your-site.com/cancelled"
}

Custom Slug

Create a memorable URL:

{
  "slug": "donate-2024"
}

The URL will be: https://checkout.yabetoo.com/p/donate-2024

Complete Example

curl -X POST https://api.yabetoo.com/v1/payment-links \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "product",
    "name": "Training Shop",
    "description": "Online courses",
    "slug": "training",
    "currency": "XOF",
    "collectBillingAddress": true,
    "allowPromotionCodes": true,
    "successUrl": "https://your-site.com/success",
    "cancelUrl": "https://your-site.com/cancel",
    "maxRedemptions": 500,
    "expiresAt": "2024-12-31T23:59:59Z",
    "items": [
      {
        "productId": "prod_js_course",
        "priceId": "price_js_course",
        "quantity": 1,
        "adjustableQuantity": false
      },
      {
        "productId": "prod_react_course",
        "priceId": "price_react_course",
        "quantity": 1,
        "isOptional": true
      }
    ],
    "metadata": {
      "campaign": "summer_2024",
      "source": "newsletter"
    }
  }'

Response

{
  "id": "plink_abc123def456ghi789jkl012",
  "object": "payment_link",
  "type": "product",
  "name": "Training Shop",
  "description": "Online courses",
  "slug": "training",
  "url": "https://checkout.yabetoo.com/p/training",
  "currency": "XOF",
  "amount": null,
  "minAmount": null,
  "maxAmount": null,
  "isActive": true,
  "expiresAt": "2024-12-31T23:59:59.000Z",
  "maxRedemptions": 500,
  "redemptionCount": 0,
  "collectBillingAddress": true,
  "collectShippingAddress": false,
  "allowPromotionCodes": true,
  "successUrl": "https://your-site.com/success",
  "cancelUrl": "https://your-site.com/cancel",
  "items": [
    {
      "id": "plitem_abc123",
      "productId": "prod_js_course",
      "priceId": "price_js_course",
      "name": "JavaScript Course",
      "description": "Master JavaScript",
      "quantity": 1,
      "adjustableQuantity": false,
      "isOptional": false,
      "sortOrder": 0
    },
    {
      "id": "plitem_def456",
      "productId": "prod_react_course",
      "priceId": "price_react_course",
      "name": "React Course",
      "description": "Build React apps",
      "quantity": 1,
      "adjustableQuantity": false,
      "isOptional": true,
      "sortOrder": 1
    }
  ],
  "metadata": {
    "campaign": "summer_2024",
    "source": "newsletter"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Response Fields

Field	Description
`id`	Unique link identifier
`url`	Public URL to share
`slug`	Slug used in the URL
`isActive`	Indicates if the link is active
`redemptionCount`	Number of times the link has been used
`items`	List of items (for `product` type)

Common Operations

Retrieve a Link

curl https://api.yabetoo.com/v1/payment-links/plink_abc123 \
  -H "Authorization: Bearer sk_live_..."

Update a Link

curl -X PATCH https://api.yabetoo.com/v1/payment-links/plink_abc123 \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Name",
    "isActive": false
  }'

Deactivate a Link

curl -X PATCH https://api.yabetoo.com/v1/payment-links/plink_abc123 \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "isActive": false
  }'

Delete a Link

curl -X DELETE https://api.yabetoo.com/v1/payment-links/plink_abc123 \
  -H "Authorization: Bearer sk_live_..."

List Links

curl "https://api.yabetoo.com/v1/payment-links?type=product&isActive=true" \
  -H "Authorization: Bearer sk_live_..."

Webhooks

Receive notifications when a payment is made via a link:

{
  "type": "payment_link.payment.completed",
  "data": {
    "object": {
      "paymentLinkId": "plink_abc123",
      "sessionId": "plsession_xyz789",
      "amount": 25000,
      "currency": "XOF",
      "customerEmail": "customer@example.com",
      "status": "completed"
    }
  }
}

Available Events

Event	Description
`payment_link.created`	Link created
`payment_link.updated`	Link updated
`payment_link.payment.completed`	Successful payment via link
`payment_link.payment.failed`	Failed payment

Best Practices

Security

Always create links server-side
Never store API keys client-side
Use webhooks to verify payments

User Experience

Use memorable slugs for important links
Add a clear description
Set a reasonable expiration date

Management

Use metadata for tracking (campaign, source, etc.)
Monitor redemptionCount for limited offers
Deactivate links rather than deleting them

Next Steps

Share a Link

Learn how to share your links effectively

Webhooks

Configure real-time notifications

Get started

Build a checkout page

Build an advanced payments integration

Disbursements

Remittance

Use Payment Links

Create a Payment Link