Skip to main content
POST
/
payment-links
Create payment link
curl --request POST \
  --url https://app.dilli.studio/api/v1/payment-links \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "payment_provider_account_id": "<string>"
}
'
{
  "id": "<string>",
  "public_token": "<string>",
  "name": "<string>",
  "description": "<string>",
  "amount": 123,
  "currency": "<string>",
  "is_active": true,
  "max_installments": 123,
  "interest_rate": 123,
  "is_recurring": true,
  "interval_unit": "<string>",
  "interval_count": 123,
  "billing_cycles": 123,
  "payment_provider_account_id": "<string>",
  "provider_account": {
    "id": "<string>",
    "name": "<string>",
    "provider": "pagarme",
    "mode": "test"
  },
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "price_minor": 123,
      "currency": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z"
}
Use the API Playground below to send this request with your X-Api-Key. Provide a payment_provider_account_id and either an amount/currency pair or a products array (all in the same currency).

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required
payment_provider_account_id
string
required
description
string | null
products
string[]
amount
number<float> | null

Required if products is empty

currency
string

3-letter currency. Required with amount.

is_active
boolean
max_installments
integer
Required range: 1 <= x <= 24
interest_rate
number<float>
is_recurring
boolean
interval_unit
string
interval_count
integer
billing_cycles
integer | null

Response

201 - application/json

Created

id
string
public_token
string
name
string
description
string | null
amount
number<float> | null
currency
string
is_active
boolean
max_installments
integer
interest_rate
number<float>
is_recurring
boolean
interval_unit
string
interval_count
integer
billing_cycles
integer | null
payment_provider_account_id
string
provider_account
object
products
object[]
created_at
string<date-time>