API Reference
post

/smartlink/v1/smart-link

Request a smartLink that can later be used to charge a customer using the charge method for Smartlinks endpoint.

In the form you can include 3 different type of items:

  1. Inputs - useful to create tags so customers can include name, email and other important information for the business.
  2. Selects - useful to select from a list of available options.
  3. Dates - A calendar if you need the customer to select a specfic date.

Request Parameters

1 Header

Request Body

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
id: SmartLinkRequest
publicMerchantId
string
required
colors
object
banner
string
1 validation
buttons
string
1 validation
steps
string
1 validation
logo
string
required
pattern: ^https://(.*)$
enabled
boolean
paymentMethod
string
required
Allowed Values: credit-card, pse
deferred
object
deferredType
string
1 validation
months
integer
monthsOfGrace
string
1 validation
id
string
expiration
integer
executionCount
integer
executionLimit
integer
required
metadata
object
required
title
string
required
description
string
image
string
1 validation
amount
object
required
subtotalIva
number
1 validation + required
subtotalIva0
number
1 validation + required
iva
number
1 validation + required
ice
number
1 validation
currency
string
1 validation + required
months
string
form
array[anyOf]
required
object
2 validations
or
object
2 validations
or
object
2 validations

Responses

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
id: SmartLinkRequest
publicMerchantId
string
required
colors
object
banner
string
1 validation
buttons
string
1 validation
steps
string
1 validation
logo
string
required
pattern: ^https://(.*)$
enabled
boolean
paymentMethod
string
required
Allowed Values: credit-card, pse
id
string
expiration
integer
executionCount
integer
executionLimit
integer
required
metadata
object
required
title
string
required
description
string
image
string
1 validation
amount
object
required
subtotalIva
number
1 validation + required
subtotalIva0
number
1 validation + required
iva
number
1 validation + required
ice
number
1 validation
currency
string
1 validation + required
form
array[anyOf]
required
object
2 validations
or
object
2 validations
or
object
2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.