Skip to main content
POST
/
v1
/
payments
/
links
curl --request POST \
  --url https://api.sandbox.busha.so/v1/payments/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "invoice",
  "fixed": true,
  "one_time": true,
  "name": "Invoice for Consulting Services",
  "title": "Consulting Services - March 2024",
  "description": "Payment for consulting services rendered",
  "target_currency": "USDC",
  "target_amount": "500.00",
  "customer_email": "client@example.com",
  "customer_name": "John Doe",
  "due_date": "2024-04-15T00:00:00Z",
  "note": "Thank you for your business!",
  "items": [
    {
      "item": "Consulting Hours",
      "quantity": 10,
      "amount": "40.00"
    },
    {
      "item": "Documentation Fee",
      "quantity": 1,
      "amount": "100.00"
    }
  ]
}
'
{
  "status": "success",
  "message": "Payment link created successfully",
  "data": {
    "id": "PAYL_abc123xyz",
    "profile_id": "PROF_user123",
    "type": "invoice",
    "fixed": true,
    "one_time": true,
    "link": "https://pay.busha.io/charges/PAYL_abc123xyz",
    "name": "Invoice for Consulting Services",
    "title": "Consulting Services - March 2024",
    "description": "Payment for consulting services rendered",
    "target_currency": "USDC",
    "target_amount": "500.00",
    "meta": {
      "customer_email": "client@example.com",
      "customer_name": "John Doe",
      "due_date": "2024-04-15T00:00:00Z",
      "note": "Thank you for your business!",
      "items": [
        {
          "item": "Consulting Hours",
          "quantity": 10,
          "amount": "40.00"
        },
        {
          "item": "Documentation Fee",
          "quantity": 1,
          "amount": "100.00"
        }
      ]
    },
    "status": "active",
    "created_at": "2024-03-10T12:00:00Z",
    "updated_at": "2024-03-10T12:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Body

application/json
​
fixed
boolean
required
​
one_time
boolean
required
​
name
string
required
​
title
string
required
​
description
string
required
​
target_currency
string<string>
required

A valid currency

Required string length: 1 - 10
Example:

"BTC"

​
type
enum<string>

Optional. Derived from fixed/one_time if not provided

Available options:
payment_link,
invoice
​
quote_amount
string

decimal value

Example:

"100"

​
quote_currency
string<string>

A valid currency

Required string length: 1 - 10
Example:

"BTC"

​
target_amount
string

decimal value

Example:

"100"

​
require_extra_info
object[]
​
images
string<url>[]
​
allow_customer_amount
boolean
​
amount_limit
object
​
allow_quantity_selection
boolean
​
customer_email
string<email>

Required when type is invoice

​
customer_name
string

Required when type is invoice

​
due_date
string<date-time>

Optional due date for invoice (must be in the future)

​
note
string

Optional note for invoice (max 250 characters)

Maximum string length: 250
​
items
object[]

Line items for invoice type payment links

​
dry_run
boolean

if true, will not create a payment transfer

Response

Successful response

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required