GET
/
pay
/
{shortCode}
Get payment link by short code
curl --request GET \
  --url https://api.simiz.io/v1/pay/{shortCode}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "shortCode": "Ab12Cd34",
  "url": "https://pay.simiz.io/pay/Ab12Cd34",
  "name": "Monthly Invoice",
  "description": "Pay your monthly invoice",
  "amount": 5000,
  "currency": "XAF",
  "minAmount": null,
  "maxAmount": null,
  "status": "ACTIVE",
  "collectPhone": true,
  "collectEmail": true,
  "collectName": false,
  "customFields": [],
  "maxUses": null,
  "usageCount": 12,
  "expiresAt": null,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "merchantName": "My Store",
  "merchantLogo": "https://cdn.simiz.io/logos/store.png",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

Path Parameters

​
shortCode
string
required

8-character alphanumeric short code

Example:

"Ab12Cd34"

Response

Payment link details

​
id
string<uuid>
​
shortCode
string

8-character alphanumeric code used in the URL

Example:

"Ab12Cd34"

​
url
string<uri>

Full payment link URL

Example:

"https://pay.simiz.io/pay/Ab12Cd34"

​
name
string

Link name / title

Example:

"Monthly Invoice"

​
description
string | null

Optional description shown to the customer

​
amount
number | null

Fixed amount in smallest currency unit, or null for variable-amount links

Example:

5000

​
currency
string

ISO 4217 currency code

Example:

"XAF"

​
minAmount
number | null

Minimum amount for variable-amount links

​
maxAmount
number | null

Maximum amount for variable-amount links

​
status
enum<string>

Payment link lifecycle:

  • ACTIVE — Link is live and accepting payments
  • INACTIVE — Link is disabled by the merchant
  • EXPIRED — Link has passed its expiration date
Available options:
ACTIVE,
INACTIVE,
EXPIRED
​
collectPhone
boolean

Whether the customer is asked for their phone number

​
collectEmail
boolean

Whether the customer is asked for their email

​
collectName
boolean

Whether the customer is asked for their full name

​
customFields
object[]

Custom fields to collect from the customer

​
maxUses
integer | null

Maximum number of uses allowed, or null for unlimited

​
usageCount
integer

Current number of times this link has been used

​
expiresAt
string<date-time> | null

Expiration date, or null if the link does not expire

​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
merchantName
string

Organization name (only included on public endpoint)

​
merchantLogo
string | null

Organization logo URL (only included on public endpoint)

​
projectId
string<uuid>

Project UUID (only included on public endpoint)