Skip to main content
POST

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