Skip to main content
POST
/
payment-links
Create a new payment link
curl --request POST \
  --url https://api.example.com/payment-links \
  --header 'Content-Type: application/json' \
  --data '
{
  "amountType": "FIXED",
  "reference": "INV-2024-001",
  "amountInCents": 100000,
  "callbackUrl": "https://example.com/callback"
}
'
{
  "paymentLinkId": "ad78347a-9fd5-40b3-9e18-d89a0fe9989d",
  "paymentLinkUrl": "https://pay.hellopay.com.co/link/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "expiresAt": "2024-01-02T00:00:00.000Z",
  "status": "PENDING",
  "inlineCustomer": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "idType": "CO_CC",
    "idNumber": "1234567890"
  },
  "rail": "BRE_B"
}

Body

application/json
​
amountType
string
required

Amount type for the payment link. Only FIXED is currently supported

Example:

"FIXED"

​
reference
string
required

Unique reference for the payment link

Example:

"INV-2024-001"

​
amountInCents
number
required

Fixed amount in cents for the payment link

Required range: x >= 1
Example:

100000

​
callbackUrl
string
required

Callback URL that will be attached to payins created from this payment link

Example:

"https://example.com/callback"

​
rail
enum<string>

Payment rail. Restricts which rail the customer must use.

Available options:
BRE_B,
PSE
Example:

"PSE"

​
inlineCustomer
object

Pre-established customer data attached to payins created from this link

​
pse
object

PSE payment details attached to this payment link when rail is PSE

Response

Payment link successfully created

​
paymentLinkId
string
required

Unique payment link ID

Example:

"ad78347a-9fd5-40b3-9e18-d89a0fe9989d"

​
paymentLinkUrl
string
required

URL to share with the customer to complete the payment using the payment link

Example:

"https://pay.hellopay.com.co/link/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
expiresAt
string<date-time>
required

Expiration timestamp

Example:

"2024-01-02T00:00:00.000Z"

​
status
string
required

Payment link status

Example:

"PENDING"

​
inlineCustomer
object
required

Payment link customer data

Example:
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "idType": "CO_CC",
  "idNumber": "1234567890"
}
​
rail
object
required

Payment link rail

Example:

"BRE_B"