Pixalink Developer Docs
Postman collection → OpenAPI spec →Start here
Connect your POS to Pixalink loyalty. Identify a customer, apply their reward at checkout, and record the sale so they earn points.
How the pieces fit together
Your POS owns the bill and payment. Pixalink owns the loyalty balance and reward status. A successful checkout connects the two:
flowchart LR
accTitle: Responsibilities during a POS checkout
accDescr: The customer presents a reward. The POS validates it with Pixalink, applies the discount and collects payment, then asks Pixalink to redeem the reward and record the sale.
subgraph Customer
A[Present reward code]
end
subgraph POS[Your POS]
B[Validate reward]
C[Apply discount]
D[Confirm payment]
end
subgraph Pixalink
E[Check eligibility]
F[Mark reward Used]
G[Record sale and award points]
end
A --> B --> E
E --> C --> D --> F --> G
Validation is a read-only check. It does not reserve the reward or mark it used. Only redeem after payment succeeds, and handle a failed redemption explicitly.
Rewards, customer rewards, and voucher codes
In merchant conversations, "voucher" often means a reward held by a customer. The API separates the offer, the customer's issued reward, and an optional pool of codes:
| API resource | What it represents | Example | When to use it |
|---|---|---|---|
Reward — /api/rewards |
The offer and its rules, shared by everyone who receives it. | "RM10 off" or "Free coffee". | Read or manage the reward definition. |
Customer Reward — /api/customer_rewards |
One issued reward belonging to one customer, with its own ID, expiry, and usage status. | Sarah's RM10 discount, still unused. | Find what a customer holds and redeem it at POS checkout. |
Reward Voucher — /api/rewards/{reward_id}/vouchers |
A code in a reward's pool, which can exist before anyone receives it. | An imported partner code, PARTNER-ABC. |
Import and manage codes for rewards that draw from a code pool. |
flowchart TD
accTitle: Reward definition, customer entitlement, and optional voucher code
accDescr: A reward defines the offer. Issuing it creates a customer reward for Sarah. If the reward uses a code pool, one voucher code is assigned and linked to her customer reward. Standard rewards do not require a pooled code.
R[Reward definition: the offer] -->|Issued to Sarah| C[Customer Reward: Sarah's entitlement]
R -->|Optional code pool| V[Reward Voucher: PARTNER-ABC]
V -.->|Assigned and linked when issued| C
A regular free-coffee reward needs no imported voucher codes. Sarah still receives a customer reward that your POS can validate and redeem. For a partner voucher, her customer reward can also carry a code drawn from the pool.
The IDs are separate: reward_id identifies the offer, the voucher endpoint's ID identifies a pool entry, and the customer reward ID identifies Sarah's issued reward. After POS validation, use data.id from the validation response to redeem the customer reward.
Customer Rewards API · Voucher code pool API · Checkout walkthrough
Your first request
- Ask the merchant to enable POS integration and agree your provider namespace with Pixalink, such as
ivendorzeoniq. - Generate one Outlet API Key per outlet in Outlets → open an outlet → Configurations → Outlet API Key. Keep the key on your backend or trusted POS; never put it in a public browser app.
- Call
GET /api/userto confirm the key belongs to the intended outlet.
curl --request GET "https://explore.pixalink.io/api/user" \
--header "Authorization: Bearer YOUR_OUTLET_API_KEY" \
--header "Accept: application/json"
An outlet key returns is_service_account: true and an outlet object. Check outlet.name and outlet.id before enabling the terminal. A Personal Access Token identifies a staff member instead and returns outlet: null.
Keys are shown once. Regenerating or revoking a key stops the previous key working immediately. Coordinate the replacement across that outlet's terminals.
See the authentication reference · Try GET /api/user
Redeem rewards
The recommended path starts with the customer's six-digit reward code. Keep it as a string so leading zeroes survive. Phone lookup is a fallback when the customer cannot access their app.
Checkout from start to finish
sequenceDiagram
accTitle: Reward redemption after successful payment
accDescr: Validate the code, check the POS discount configuration, collect payment, then mark the reward Used and post the sale. A failed payment leaves the reward Pending.
participant Customer
participant Cashier
participant POS as Your POS
participant API as Pixalink API
Customer->>Cashier: Present six-digit code
Cashier->>POS: Enter code
POS->>API: POST /api/customer_rewards/validate
API-->>POS: Reward, customer, and discount configuration
POS->>POS: Check provider enabled and apply discount
POS->>Customer: Collect payment
alt Payment succeeds
POS->>API: PATCH /api/customer_rewards/{id} (Used)
API-->>POS: Redemption confirmed
POS->>API: POST /api/posTransaction (positive amount)
API-->>POS: Sale recorded
POS-->>Cashier: Checkout complete
else Payment fails or is cancelled
POS-->>Cashier: Leave reward Pending without redeeming
end
The diagram shows the successful API path. If payment succeeds but redemption fails or times out, retain the payment and reward references for reconciliation; do not silently treat the reward as redeemed. See recovery.
Validate the code
curl --request POST "https://explore.pixalink.io/api/customer_rewards/validate" \
--header "Authorization: Bearer YOUR_OUTLET_API_KEY" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '{"code":"482916"}'
On success, save data.id as the customer reward ID and data.customer_id as the customer ID. The reward ID in data.reward.id identifies the reward definition; it is not the ID to redeem.
| Result | What the POS should do |
|---|---|
200, valid: true |
Check the provider configuration before offering the discount. |
422, CODE_NOT_FOUND |
Ask the cashier to check the code. |
422, CODE_EXPIRED |
Explain that the code expired. |
422, CODE_ALREADY_USED |
Stop this redemption; the reward has already been used. |
422, field validation errors |
Correct the request. The code must contain exactly six digits. |
429 |
Wait before trying again; honour Retry-After when supplied. |
Validation request and response reference
Read the discount correctly
Replace {pos} with the namespace agreed with Pixalink. Continue only when reward.properties.{pos}.enabled === true.
{
"reward": {
"id": 5,
"name": "RM10 off",
"amount": 100,
"properties": {
"your_pos": { "enabled": true, "type": "amount", "amount": 10 }
}
}
}
| Field | Meaning in this example |
|---|---|
reward.amount |
100 loyalty points to claim the reward. Not the bill discount. |
reward.properties.your_pos.amount |
RM10 off the bill, for an amount discount. |
POS transaction amount |
Integer cents: a RM90 sale is 9000. |
Confirm redemption
After successful payment, send the customer reward ID returned by validation:
PATCH /api/customer_rewards/101
Authorization: Bearer YOUR_OUTLET_API_KEY
Accept: application/json
Content-Type: application/json
{"status":"Used"}
Pixalink sets the redemption timestamp and outlet attribution. Save the returned customer reward ID alongside your receipt reference in your own system.
Update customer reward reference — this resource accepts both PUT and PATCH.
Fallback: find a customer by phone
sequenceDiagram
accTitle: Customer lookup when a reward code is unavailable
accDescr: Search customers by phone, confirm the correct customer, then list their Pending rewards and continue with the normal checkout flow.
participant Cashier
participant POS as Your POS
participant API as Pixalink API
Cashier->>POS: Enter customer phone number
POS->>API: GET /api/customers?filter[phone_number]=...
API-->>POS: Paginated customer matches
POS-->>Cashier: Confirm the correct customer
Cashier->>POS: Select customer
POS->>API: GET /api/customer_rewards?filter[customer_id]=42&filter[status]=Pending&include=reward
API-->>POS: Pending rewards and provider configuration
Cashier->>POS: Select reward
Note over POS,API: Continue with provider checks, payment, and redemption
Phone search supports partial matching. Confirm the customer's identity and select the right result; never automatically take the first match. If no customer matches, stop the lookup and show a clear message. Check expiry as well as status before offering a reward.
Customer lookup reference · List customer rewards
Sales, refunds, and voids
Reward redemption and point earning are separate operations. A successful reward PATCH does not record a sale. Post the sale separately so the customer can earn points.
Record a sale
Send POST /api/posTransaction with a positive amount in integer cents. This example records RM100. The payload field is a JSON string, not a nested JSON object.
{
"ref_id": "BANGSAR-SALE-1001",
"transaction_time": "2026-10-30T12:30:00+08:00",
"amount": 10000,
"payload": "{\"receipt_number\":\"1001\"}",
"customer_id": 42
}
Use a stable, organisation-wide unique ref_id; include an outlet prefix if receipt numbers repeat across outlets. Keep the same ID and request when retrying. Use the actual sale time, not the example date.
| Response | Meaning |
|---|---|
201 |
A new transaction was recorded. |
200, “Transaction already recorded” |
This ref_id was already recorded; the original record is returned. |
409 |
Another request with this ref_id is still in flight. Wait briefly and retry the same request. |
Sale and refund request reference
Choose the right reversal
flowchart TD
accTitle: Choose between cancellation, void, and refund
accDescr: A failed payment leaves the reward Pending. Void an already recorded sale to reverse its earned points. A return after purchase is a negative transaction, with linked and blind refund modes. Voucher restoration is a separate decision.
A{What happened?}
A -->|Payment failed; nothing recorded| B[Leave reward Pending]
A -->|Recorded sale cancelled| C[Void the POS transaction]
A -->|Items returned after purchase| D[Post a negative POS transaction]
D --> E{Original sale reference available?}
E -->|Yes| F[Linked refund: include original_ref_id]
E -->|No| G[Blind refund: current tier rules]
F --> H[Reward stays Used]
G --> H
C --> I[Points reversal; voucher handled separately]
| Situation | Points | Voucher |
|---|---|---|
| Payment fails before anything is recorded | No sale to reverse. | Leave it Pending. |
| A recorded sale is cancelled | Use POST /api/posTransaction/{id}/void. |
The generic void endpoint does not automatically restore a voucher. |
| Customer returns items after purchase | Post a refund with a negative amount. | Stays Used, including a full refund. |
Some provider-specific integrations handle voucher reversal automatically. Do not assume that behaviour applies to the generic API documented here.
Void POS transaction reference
Linked and blind refunds
A refund uses the same endpoint as a sale, with a negative amount, its own unique ref_id, and an existing customer identified by customer_id or phone_number.
{
"ref_id": "BANGSAR-REFUND-1001-1",
"original_ref_id": "BANGSAR-SALE-1001",
"transaction_time": "2026-10-30T15:00:00+08:00",
"amount": -4000,
"payload": "{}",
"customer_id": 42
}
This returns RM40 against the original RM100 sale.
| Mode | Use when | Points calculation |
|---|---|---|
| Linked refund | You have the original sale's ref_id. |
Proportional to the points originally earned, rounded down. If RM100 earned 150 points, a RM40 refund reverses 60 points. |
| Blind refund | You cannot provide the original reference. Omit original_ref_id. |
Uses the customer's current tier multiplier and refund value in currency units. |
Linked refunds cannot exceed the original sale's remaining refundable amount. Blind refunds require sufficient points. Refunds do not create missing customers. With an outlet key, the original transaction must belong to that same outlet.
If validation rejects a refund, inspect the returned field errors before resubmitting. Confirm exceptional cases such as voiding a refund with Pixalink before implementing them.
Reward lifecycle
Keep the payment state in your POS separate from the reward's status in Pixalink. Validated is not a stored reward status.
stateDiagram-v2
accTitle: Customer reward states
accDescr: A reward starts Pending. Validation leaves it Pending. Payment followed by a successful redemption changes it to Used. A permitted correction within one hour can restore Pending. Expired rewards cannot be updated.
[*] --> Pending
Pending --> Pending: Validate only
Pending --> Used: Payment succeeds, then redeem
Used --> Pending: Explicit correction within one hour
Pending --> Expired: Expiry reached
note right of Used
A refund does not restore the voucher
end note
Expired --> [*]
Correct an accidental redemption
If a reward was marked used by mistake, request a correction within one hour of redemption:
PATCH /api/customer_rewards/101
Authorization: Bearer YOUR_OUTLET_API_KEY
Accept: application/json
Content-Type: application/json
{"status":"Pending","used_at":null}
The API clears the redemption audit fields automatically. This makes the voucher usable again; it does not refund the points originally spent to claim it. Expired rewards cannot be updated, and the correction window does not extend a reward's expiry.
Recover without duplicating
Persist your sale reference and customer reward ID before sending requests. A timeout means the outcome is unknown; it does not mean the operation failed.
Retry a sale or refund safely
sequenceDiagram
accTitle: Retrying a POS transaction without awarding points twice
accDescr: If a sale or refund request times out, repeat it with the same reference. Pixalink returns either the existing transaction, the new transaction, or a temporary conflict that can be retried.
participant POS as Your POS
participant API as Pixalink API
POS->>API: POST transaction with ref_id BANGSAR-SALE-1001
API--xPOS: Response lost or timeout
POS->>API: Retry same payload and same ref_id
alt Already recorded
API-->>POS: 200 with original transaction
else Not recorded yet
API-->>POS: 201 with new transaction
else First request still running
API-->>POS: 409 conflict
Note over POS: Wait briefly, then retry the same request
end
Never generate a new ref_id for a retry: that describes a second sale or refund.
Recover a reward update
After a redemption timeout, read GET /api/customer_rewards/{id} before deciding what to do:
- Used: do not send another redemption. Reconcile it with your saved payment and receipt records; a Used status alone does not identify which terminal redeemed it.
- Pending: confirm payment succeeded before retrying the update. Handle
CODE_ALREADY_USEDif another request wins the race. - Expired, missing, or unexpected response: stop automatic redemption and flag the checkout for review.
After a POS restart, use the saved payment result to make the same decision. Never mark a reward used just because it was validated before the crash.
Handle errors deliberately
| Result | Recovery |
|---|---|
Network timeout or 5xx |
Reconcile reward updates first. For sales/refunds, retry the same ref_id with bounded backoff, for example 2, 4, then 8 seconds. |
409 on a POS transaction |
Wait briefly and retry the same request. |
429 |
Honour Retry-After when present; otherwise back off. |
401 |
Check or replace the key. Do not keep retrying an invalid key. |
403 |
Check permissions, POS integration access, and any expired correction window. |
404 |
Check the record ID and organisation context. |
422 |
Read the error code or field errors and correct the request. |
Before going live
- Verify each terminal's key resolves to the correct outlet.
- Exercise valid, expired, unknown, and already-used reward codes.
- Confirm failed payments leave rewards Pending.
- Check the POS discount value is not confused with point cost or transaction cents.
- Retry a timed-out sale with the same reference and confirm only one sale exists.
- Test linked refunds, blind refunds, and a rejected refund.
- Test a redemption timeout, a POS restart, and the one-hour correction limit.
The endpoint reference below includes request fields, response examples, and an API tester. Try it out sends real requests to the displayed base URL; use test credentials and test records for write operations.
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
For POS integrations, use one Outlet API Key per outlet. See the connection setup guide. Personal Access Tokens remain available for staff integrations. Contact Pixalink support to arrange API access.
Categories
Categories provide a hierarchical classification system for organising spaces within the platform.
The system uses a two-level structure where main categories (e.g., Food & Beverage, Retail)
contain subcategories (e.g., Restaurant, Cafe, Hotel) that spaces can be assigned to.
This helps in filtering and discovering spaces based on their business type or industry.
List categories
Returns a paginated list of categories. By default, only returns second level categories (categories that have a parent).
Headers
Query Parameters
Page number for pagination.
Number of items per page.
Comma-separated list of relations to include. Allowed values:
- parent
Field to sort by. Prefix with - for descending order. Allowed values:
- name
- created_at
- updated_at
Filter by name (partial match).
Filter by parent ID. If set to null or 0, returns main categories.
Filter by ID.
Filter by exact slug match.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/categories?page=1&per_page=15&include=parent&sort=-created_at&filter%5Bname%5D=Restaurant&filter%5Bparent_id%5D=1&filter%5Bid%5D=1&filter%5Bslug%5D=restaurant" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 5,
"name": "Restaurant",
"parent_id": 1
},
{
"id": 6,
"name": "Cafe",
"parent_id": 1
},
{
"id": 7,
"name": "Hotel",
"parent_id": 2
}
],
"links": {
"first": "{{$baseUrl}}/api/categories?page=1",
"last": "{{$baseUrl}}/api/categories?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "{{$baseUrl}}/api/categories",
"per_page": 15,
"to": 3,
"total": 3
}
}
Credits
List Credits
Get a paginated list of credits for the organisation.
Headers
Query Parameters
Filter by customer ID.
Filter by credit type.
Filter by space ID.
Filter by amount in ringgit, up to 2 decimal places (the same unit as the amount response field), optionally prefixed with an operator (>, >=, <, <=, =, <>). >100 matches credits above RM100.00.
Sort field (created_at, amount).
Include relationships (customer, space, reward).
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/credits?filter%5Bcustomer_id%5D=1&filter%5Btype%5D=Top+Up&filter%5Bspace_id%5D=1&filter%5Bamount%5D=%3E100&sort=-created_at&include=customer&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"customer_id": 42,
"space_id": 1,
"amount": "50.00",
"operation": "+",
"type": "Top Up",
"remarks": "Birthday top-up",
"created_at": "2025-05-06T14:30:01.000000Z",
"updated_at": "2025-05-06T14:30:01.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Credit
Creates a new credit entry for a customer (top up, deduct, revert, etc.).
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/credits" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 42,
\"phone_number\": \"+60123456789\",
\"amount\": \"50.00\",
\"type\": \"Top Up\",
\"space_id\": 1,
\"remarks\": \"Birthday top-up\",
\"custom_properties\": [],
\"source_credit_id\": 10
}"
{
"data": {
"id": 1,
"customer_id": 42,
"space_id": 1,
"amount": "50.00",
"operation": "+",
"type": "Top Up",
"remarks": "Birthday top-up",
"created_at": "2025-05-06T14:30:01.000000Z",
"updated_at": "2025-05-06T14:30:01.000000Z"
}
}
Get Credit Details
Retrieve detailed information about a specific credit.
Headers
URL Parameters
The ID of the credit.
Query Parameters
Relationships to include (customer, space, reward).
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/credits/1?include=customer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"customer_id": 42,
"space_id": 1,
"amount": "50.00",
"operation": "+",
"type": "Top Up",
"remarks": "Birthday top-up",
"created_at": "2025-05-06T14:30:01.000000Z",
"updated_at": "2025-05-06T14:30:01.000000Z"
}
}
Customer Paid Memberships
List Customer Paid Memberships
Returns a paginated list of customer paid membership instances. Records are scoped to the authenticated user's organisation via the model's global scope.
Headers
Query Parameters
Comma-separated relationships to include. Available: customer, paidMembershipType, transactions, payments, activePayment. Use payments to retrieve all payment records for reconciliation, or activePayment to retrieve only the currently linked payment.
Filter by customer ID.
Filter by membership type ID.
Filter by active flag.
Filter by billing cycle (monthly, quarterly, semi_annual, yearly, or lifetime).
Filter by expiry date using comparison operators (>, <, =). ISO 8601 date.
Sort field and direction. Prefix with - for descending. Available: created_at, starts_at, expires_at. Defaults to -created_at.
Number of records per page. Defaults to 15.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customer_paid_memberships?include=paidMembershipType%2Ccustomer&filter%5Bcustomer_id%5D=1&filter%5Bpaid_membership_type_id%5D=1&filter%5Bis_active%5D=1&filter%5Bbilling_cycle%5D=yearly&filter%5Bexpires_at%5D=%3E2025-04-01&sort=-expires_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2025-04-01",
"expires_at": "2025-05-01",
"auto_renew": false,
"is_active": true,
"payment_status": "paid"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Assign a Paid Membership
Assigns a paid membership of the given type and billing cycle to a customer. Delegates
lifecycle logic to PaidMembershipService::assignMembership, which records a ManualAssign
transaction and issues any rewards configured on the membership type.
When the customer already has an active membership, the on_existing field decides
what happens. It defaults to renew: the same type and billing cycle appends another cycle
to the existing membership — measured from its current expiry, so unused days are never
lost — and records a Renewal transaction instead of creating a second row. Switching to a
different plan requires on_existing=replace, which deactivates the current membership
(logging a Replaced transaction) and starts a fresh term from today; the remaining days
are forfeited, which is why it is never the default. on_existing=reject refuses outright.
Anything that is not a clean renewal returns 409 with the blocking membership in the
response body. An active lifetime membership always returns 409 — deactivate it first.
If the integrator has already collected payment in their own system, an optional payment
object may be supplied. When present, a Payment row is recorded against the membership
and a ManualPayment transaction is logged. The accepted payment.method values (cash,
card, e_wallet) are deliberately limited to manually-recorded instruments — gateway
methods are not accepted via this endpoint. Omit payment entirely for free/comp
assignments.
payment.reference_id is treated as an idempotency key. If it matches a payment already
recorded against a membership for this customer, the existing membership is returned with
200 and nothing is created — so a POS that times out and retries cannot double-assign
or re-issue rewards. Send your own transaction identifier to get this protection. Payment
references are unique across the platform: reusing one that belongs to a different payment
returns 422 rather than recording a duplicate.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/customer_paid_memberships" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 1,
\"paid_membership_type_id\": 1,
\"billing_cycle\": \"monthly\",
\"space_id\": 1,
\"starts_at\": \"2025-04-01\",
\"on_existing\": \"renew\",
\"remarks\": \"Manually assigned by support after refund.\",
\"payment\": {
\"method\": \"cash\",
\"amount\": 99,
\"currency\": \"MYR\",
\"reference_id\": \"POS-12345\",
\"remarks\": \"Paid at counter\"
}
}"
{
"data": {
"id": 1,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2025-04-01",
"expires_at": "2025-05-01",
"is_active": true
},
"message": "Paid membership already recorded for this payment reference"
}
Show Customer Paid Membership
Retrieves a single customer paid membership by ID. Cross-organisation access returns 404.
Headers
URL Parameters
The ID of the membership instance.
Query Parameters
Comma-separated relationships to include. Available: customer, paidMembershipType, transactions, payments, activePayment. Use payments to retrieve all payment records for reconciliation, or activePayment to retrieve only the currently linked payment.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customer_paid_memberships/1?include=payments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2025-04-01",
"expires_at": "2025-05-01",
"auto_renew": false,
"is_active": true
}
}
Update Customer Paid Membership
Either extends the membership (via extend_days + remarks) or toggles auto_renew.
The two operations are mutually exclusive — sending both at once returns a 422.
Extending delegates to PaidMembershipService::extendMembership, which records a
ManualExtend transaction and sends the customer the configured notification.
Headers
URL Parameters
The ID of the membership to update.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/customer_paid_memberships/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"extend_days\": 14,
\"remarks\": \"Goodwill extension after service outage.\",
\"auto_renew\": true
}"
{
"data": {
"id": 1,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2025-04-01",
"expires_at": "2025-05-15",
"auto_renew": true,
"is_active": true
},
"message": "Paid membership updated successfully"
}
Cancel Customer Paid Membership
Cancels (deactivates) the customer's paid membership. Sets is_active to false and
records a Cancelled transaction for the audit trail. The row is not hard-deleted —
historical lookups remain intact.
Headers
URL Parameters
The ID of the membership to cancel.
curl --request DELETE \
"https://explore.pixalink.io/api/customer_paid_memberships/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" [Empty response]
Customer Rewards
A customer reward is one reward issued to one customer, such as Sarah's RM10 discount.
It records who owns the reward, its expiry, and whether it is Pending, Used, or Expired.
Use these endpoints to list a customer's rewards, issue a reward, or mark an issued reward as used after successful payment.
A reward defines the offer and its rules. A reward voucher is a code in a reward's code pool, often imported from an external partner. An issued customer reward may use a pooled code, but it does not require one. For POS redemption, use the customer reward ID returned by validation, not the reward definition ID or voucher pool entry ID. Compare all three resources or follow the checkout guide.
List Customer Rewards
Returns a paginated list of customer rewards belonging to the authenticated user's organisation. Results can be filtered, sorted and include related data through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include:
- customer
- reward
- validatedAtSpace
- validatedByUser
Filter by reward status (Pending, Used, Expired).
Filter by exact reward code match.
Filter by expiry date with operators (>, <, =).
Filter by redemption date with operators (>, <, =).
Return only customer rewards changed after (or before) a moment, with operators (>, <, =). Being issued, used, expired, or given a code all count as a change. To sync incrementally, pass the time your previous sync started (or the latest updated_at you received) instead of reading every customer reward again. A value ending in Z or an offset such as +08:00 (URL-encode + as %2B) is converted for you; a value without one is read in the server's local time. Deleted customer rewards are not returned.
Filter by customer ID.
Filter by reward ID.
Filter by validation space ID.
Filter by validator user ID.
Sort field and direction. Allowed fields: id, expired_at, used_at, created_at. Defaults to id ascending, so pages stay stable while paging through a large result.
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customer_rewards?include=customer%2Creward%2CvalidatedAtSpace%2CvalidatedByUser&filter%5Bstatus%5D=Pending&filter%5Bcode%5D=ABC123&filter%5Bexpired_at%5D=%3E2024-01-01&filter%5Bused_at%5D=%3C2024-12-31&filter%5Bupdated_at%5D=%3E2026-11-02T20%3A30%3A00Z&filter%5Bcustomer_id%5D=1&filter%5Breward_id%5D=1&filter%5Bvalidated_at_space_id%5D=1&filter%5Bvalidated_by_user_id%5D=1&sort=-created_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data":[
{
"id": 1,
"customer_id": 1,
"reward_id": 1,
"status": "Pending",
"code": "REWARD123",
"expired_at": "2024-12-31T23:59:59.000000Z",
"used_at": null,
"created_at": "2024-02-11T00:00:00.000000Z",
"updated_at": "2024-02-11T00:00:00.000000Z",
"customer" : {
"id": 1,
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"gender": 1,
"date_of_birth": "1990-05-15",
"source": "WhatsApp",
"status": "Converted",
"current_point": 2500,
"created_at": "2024-01-15T08:30:00.000000Z",
"updated_at": "2024-02-01T14:22:33.000000Z",
"notes": "Prefers to be contacted via WhatsApp",
"is_manually_assign_tier": 0,
"current_credits": 150,
"birthday_month": 5,
"tags": ["VIP", "Regular Customer"],
"space_id": 1,
"tier_id": 1,
"organisation_id": 1,
}
},
],
"links": {
"first": "{{$baseUrl}}/customer_rewards?page=1",
"last": "{{$baseUrl}}/customer_rewards?page=5",
"prev": null,
"next": "{{$baseUrl}}/customer_rewards?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/customer_rewards?page=1",
"label": "1",
"active": true
},
{
"url": "{{$baseUrl}}/customer_rewards?page=2",
"label": "2",
"active": false
},
{
"url": "{{$baseUrl}}/customer_rewards?page=3",
"label": "3",
"active": false
},
{
"url": "{{$baseUrl}}/customer_rewards?page=2",
"label": "Next »",
"active": false
}
],
"path": "{{$baseUrl}}/customer_rewards",
"per_page": 15,
"to": 15,
"total": 68
}
}
Create Customer Reward
Assigns a reward to a customer and processes the point redemption. This endpoint performs several validation checks:
- Verifies that the customer has sufficient points for the reward
- Checks if the reward has reached its total availability limit (if configured)
- For one-time rewards, ensures the customer hasn't already redeemed it
- Validates that both customer and reward belong to the authenticated organisation
Upon successful validation, the system will:
- Deduct points from the customer's balance
- Create a customer reward record
- Generate a unique redemption code
- If mark_as_redeemed is true, immediately mark the reward as used
Note: The reward's points cost is determined by its configured amount. Ensure the customer has sufficient points before making this request to avoid validation errors.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/customer_rewards" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 1,
\"reward_id\": 1,
\"mark_as_redeemed\": false,
\"currency_type\": \"point\",
\"validated_at_space_id\": 1,
\"validated_by_user_id\": 1
}"
{
"data": {
"id": 1,
"customer_id": 1,
"reward_id": 1,
"status": "Pending",
"code": "REWARD123",
"expired_at": "2024-12-31T23:59:59.000000Z",
"used_at": null,
"created_at": "2024-02-11T00:00:00.000000Z",
"updated_at": "2024-02-11T00:00:00.000000Z"
},
"message": "Customer reward created successfully"
}
Get Customer Reward Details
Retrieves detailed information about a specific customer reward.
Headers
URL Parameters
The ID of the customer reward.
Query Parameters
Comma-separated list of relationships to include (customer, reward, validatedAtSpace, validatedByUser).
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customer_rewards/1?include=customer%2Creward%2CvalidatedAtSpace%2CvalidatedByUser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"customer_id": 1,
"reward_id": 1,
"status": "Pending",
"code": "REWARD123",
"expired_at": "2024-12-31T23:59:59.000000Z",
"used_at": null,
"created_at": "2024-02-11T00:00:00.000000Z",
"updated_at": "2024-02-11T00:00:00.000000Z"
}
}
Update Customer Reward
Updates a customer reward's details.
Can update status, expiry date, and usage date.
Cannot modify rewards that are Expired or Used for more than 1 hour.
Used rewards can be corrected or reverted to Pending within 1 hour of being marked as used.
Requesting Used again during this window returns HTTP 422 with CODE_ALREADY_USED and changes nothing.
Requesting Used on a weekday the reward is not redeemable on (in the organisation's timezone) returns HTTP 422 with NOT_VALID_TODAY.
Headers
URL Parameters
The ID of the customer reward.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/customer_rewards/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"Used\",
\"expired_at\": \"2024-12-31T23:59:59Z\",
\"used_at\": \"2024-02-10T15:30:00Z\",
\"validated_at_space_id\": 1,
\"validated_by_user_id\": 1
}"
{
"data": {
"id": 1,
"status": "Used",
"expired_at": "2024-12-31T23:59:59.000000Z",
"used_at": "2024-02-11T00:00:00.000000Z",
"updated_at": "2024-02-11T00:00:00.000000Z"
},
"message": "Customer reward updated successfully"
}
Delete Customer Reward
Revokes/deletes a pending customer reward. Cannot revoke Used or Expired rewards.
Headers
URL Parameters
The ID of the customer reward.
curl --request DELETE \
"https://explore.pixalink.io/api/customer_rewards/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"message": "Customer reward revoked successfully"
}
Customers
List Customers
Returns a paginated list of customers belonging to the authenticated user's organisation.
Results can be filtered, sorted and include related data through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include:
- tier
- space
- tags
- address
- activePaidMembership.paidMembershipType (includes active paid membership with type details)
Filter by phone number (suffix match). Non-digits are ignored and the value is matched against the end of the stored number, so 0188888888, 60188888888, +60188888888 and 88888888 all find the customer stored as +60188888888.
Filter by email match.
Filter by gender. Must be one of:
- 0 (Female)
- 1 (Male)
Filter by customer source. Must be one of:
- Phone
- Direct
- Reservation
- StoreHub
- Loyverse
- Softinn
- Loyalty
Filter by customer status. Must be one of:
- Lead
- Open
- Replied
- Opportunity
- Quotation
- Lost Quotation
- Interested
- Converted
- Do Not Contact
- Blocked
Filter by points with operators (>, <, =).
Filter by credit balance in ringgit, up to 2 decimal places (the same unit as the current_credits response field), optionally prefixed with an operator (>, >=, <, <=, =, <>). >50 matches customers holding more than RM50.00.
Filter by creation time with operators (>, >=, <, <=, =, <>). Combine two with a comma for a range: >=2024-01-01,<2024-02-01 returns customers created in January 2024. A bare date means midnight, so =2024-01-01 only matches a customer created exactly at 00:00:00; use a range for a whole day. A value ending in Z or an offset such as +08:00 (URL-encode + as %2B) is converted for you; a value without one is read in the server's local time.
Return only customers changed after (or before) a moment, with the same operators and formats as filter[created_at]. To sync incrementally, pass the time your previous sync started (or the latest updated_at you received) instead of reading every customer again.
Filter by tier ID.
Filter by space ID.
Filter by tag name.
Filter by customer name (word-prefix match). Each word in the value must start a word in the customer's name or email, so joh matches John Doe but ohn does not.
Filter by birth month (1-12).
Sort field and direction. Allowed fields: name, created_at, current_point, current_credits.
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customers?include=tier%2CactivePaidMembership.paidMembershipType&filter%5Bphone_number%5D=0188888888&filter%5Bemail%5D=customer%40example.com&filter%5Bgender%5D=1&filter%5Bsource%5D=WhatsApp&filter%5Bstatus%5D=Lead&filter%5Bcurrent_point%5D=%3E100&filter%5Bcurrent_credits%5D=%3E50&filter%5Bcreated_at%5D=%3E%3D2024-01-01&filter%5Bupdated_at%5D=%3E2026-11-02T20%3A30%3A00Z&filter%5Btier%5D=1&filter%5Bspace%5D=1&filter%5Bhas_tags%5D=VIP&filter%5Bname%5D=John&filter%5Bbirthday_month%5D=10&sort=-created_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"gender": 1,
"date_of_birth": "1990-05-15",
"source": "WhatsApp",
"status": "Converted",
"current_point": 2500,
"created_at": "2024-01-15T08:30:00.000000Z",
"updated_at": "2024-02-01T14:22:33.000000Z",
"notes": "Prefers to be contacted via WhatsApp",
"is_manually_assign_tier": 0,
"current_credits": 150,
"birthday_month": 5,
"tags": [
"VIP",
"Regular Customer"
],
"space_id": 1,
"tier_id": 1,
"organisation_id": 1,
"tier": {
"id": 1,
"name": "Gold Member",
"sort": 2,
"min_point": 2000,
"color": "#FFD700",
"is_manual_assign": 1,
"point_multiplier": 1.5,
"perks": {
"birthday_multiplier": 2
},
"tier_configuration_id": 1
},
"space": {
"id": 1,
"uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
"name": "Main Branch",
"slug": "main-branch",
"matterport_model_id": null,
"description": "Our flagship store in the city centre",
"visibility": "public",
"email": "main@example.com",
"phone_number": "+60312345678",
"website": "{{$baseUrl}}",
"social_media": {
"facebook": "example",
"instagram": "example"
},
"organisation_id": 1,
"category_id": 1,
"visits": 1250,
"created_at": "2023-01-01T00:00:00.000000Z",
"updated_at": "2024-01-15T08:30:00.000000Z",
"deleted_at": null,
"links": {
"public_url": "{{$baseUrl}}/spaces/main-branch"
}
},
"address": {
"address_line_1": "123 Customer Street",
"address_line_2": "Unit 4B",
"city": "Kuala Lumpur",
"state": "Federal Territory of Kuala Lumpur",
"country": "Malaysia",
"postal_code": "50000",
"full_address": "123 Customer Street, Unit 4B, Kuala Lumpur, Federal Territory of Kuala Lumpur, 50000, Malaysia"
},
"paidMembership": {
"id": 123,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2024-01-01",
"expires_at": "2024-02-01",
"is_active": true
}
}
],
"links": {
"first": "{{$baseUrl}}/customers?page=1",
"last": "{{$baseUrl}}/customers?page=5",
"prev": null,
"next": "{{$baseUrl}}/customers?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/customers?page=1",
"label": "1",
"active": true
},
{
"url": "{{$baseUrl}}/customers?page=2",
"label": "2",
"active": false
},
{
"url": "{{$baseUrl}}/customers?page=3",
"label": "3",
"active": false
},
{
"url": "{{$baseUrl}}/customers?page=2",
"label": "Next »",
"active": false
}
],
"path": "{{$baseUrl}}/customers",
"per_page": 15,
"to": 15,
"total": 68
}
}
Create Customer
Creates a new customer in the system.
The customer will be associated with the authenticated user's organisation.
Supports tag assignment.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/customers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"John Smith\",
\"email\": \"john.smith@example.com\",
\"phone_number\": \"+60123456789\",
\"gender\": 1,
\"date_of_birth\": \"1990-01-01\",
\"space_id\": 1,
\"source\": \"WhatsApp\",
\"status\": \"Lead\",
\"tier_id\": 1,
\"is_manually_assign_tier\": true,
\"tags\": [
\"architecto\"
],
\"notes\": \"Prefers to be contacted via WhatsApp\",
\"address\": {
\"address_line_1\": \"123 Main Street\",
\"address_line_2\": \"Unit 4B\",
\"country\": \"Malaysia\",
\"state\": \"Selangor\",
\"city\": \"Petaling Jaya\",
\"postal_code\": \"46150\"
}
}"
{
"data": {
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"phone_number": "+60123456789",
"gender": 1,
"date_of_birth": "1990-01-01",
"source": "WhatsApp",
"status": "Lead",
"current_point": 0,
"notes": "Prefers evening appointments",
"custom_properties": null,
"is_manually_assign_tier": 0,
"current_credits": 0,
"birthday_month": 1,
"space_id": 1,
"organisation_id": 1,
"created_at": "2025-02-01T00:00:00.000000Z",
"updated_at": "2025-02-01T00:00:00.000000Z",
"address": {
"address_line_1": "No 39, Jalan Desa 1/1",
"address_line_2": "Taman Desa",
"city": "Petaling Jaya",
"state": "Selangor",
"country": "Malaysia",
"postal_code": "58100",
"full_address": "No 39, Jalan Desa 1/1, Taman Desa, Petaling Jaya, Selangor, 58100, Malaysia",
}
},
"message": "Customer created successfully"
}
Show Customer Details
Retrieves detailed information about a specific customer, including any requested relationships.
Headers
URL Parameters
The ID of the customer to delete.
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- tier
- space
- address
- tags
- activePaidMembership.paidMembershipType (includes active paid membership with type details)
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/customers/1?include=tier%2CactivePaidMembership.paidMembershipType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"phone_number": "+60123456789",
"gender": 1,
"date_of_birth": "1990-01-01",
"source": "WhatsApp",
"status": "Lead",
"current_point": 0,
"notes": "Prefers evening appointments",
"custom_properties": null,
"is_manually_assign_tier": 0,
"current_credits": 0,
"birthday_month": 1,
"space_id": 1,
"organisation_id": 1,
"created_at": "2025-02-01T00:00:00.000000Z",
"updated_at": "2025-02-01T00:00:00.000000Z",
"tier_id": 1,
"tier": {
"id": 1,
"name": "Bronze",
"points_required": 0
},
"paidMembership": {
"id": 123,
"membership_status": "active",
"membership_type_name": "VIP Gold",
"billing_cycle": "monthly",
"starts_at": "2024-01-01",
"expires_at": "2024-02-01",
"is_active": true
}
}
}
Update Customer
Updates an existing customer's information.
All fields are optional.
Existing tags will be synced with the provided tags array if included.
Headers
URL Parameters
The ID of the customer to delete.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/customers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"John Doe\",
\"email\": \"john@example.com\",
\"phone_number\": \"+60123456789\",
\"gender\": \"1\",
\"date_of_birth\": \"1990-01-01\",
\"space_id\": 1,
\"source\": \"WhatsApp\",
\"status\": \"Lead\",
\"tier_id\": 1,
\"is_manually_assign_tier\": true,
\"tags\": [
\"VIP\",
\"Frequent Visitor\"
],
\"notes\": \"Prefers evening appointments\",
\"address\": {
\"address_line_1\": \"No 39, Jalan Desa 1\\/1\",
\"address_line_2\": \"Taman Desa\",
\"country\": \"Malaysia\",
\"state\": \"Selangor\",
\"city\": \"Petaling Jaya\",
\"postal_code\": \"58100\"
}
}"
{
"data": {
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"phone_number": "+60123456789",
"gender": 1,
"date_of_birth": "1990-01-01",
"source": "WhatsApp",
"status": "Lead",
"current_point": 0,
"notes": "Prefers evening appointments",
"custom_properties": null,
"is_manually_assign_tier": 0,
"current_credits": 0,
"birthday_month": 1,
"space_id": 1,
"organisation_id": 1,
"created_at": "2025-02-01T00:00:00.000000Z",
"updated_at": "2025-02-01T00:00:00.000000Z",
"address": {
"address_line_1": "No 39, Jalan Desa 1/1",
"address_line_2": "Taman Desa",
"city": "Petaling Jaya",
"state": "Selangor",
"country": "Malaysia",
"postal_code": "58100",
"full_address": "No 39, Jalan Desa 1/1, Taman Desa, Petaling Jaya, Selangor, 58100, Malaysia",
}
},
"message": "Customer updated successfully"
}
Delete Customer
Queues a customer for deletion.
The deletion process runs asynchronously.
All related data will be deleted including rewards, transactions, and media (if any).
Headers
URL Parameters
The ID of the customer to delete.
curl --request DELETE \
"https://explore.pixalink.io/api/customers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"message": "Customer deletion has been queued and will be processed shortly"
}
Bulk Import Customers
Import multiple customers asynchronously.
The operation is queued and processed in chunks of 100 records.
Limited to 1,000 customers per request and rate limited to 10 requests per minute.
Headers
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/customers/bulk-import" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customers\": [
{
\"name\": \"John Doe\",
\"email\": \"john@example.com\",
\"phone_number\": \"+60123456789\",
\"gender\": 1,
\"date_of_birth\": \"1990-01-01\",
\"source\": \"WhatsApp\",
\"status\": \"Lead\",
\"notes\": \"VIP customer\",
\"tags\": [
\"VIP\",
\"WhatsApp\"
]
}
],
\"space_id\": 1
}"
{
"message": "Bulk customer import has been queued and will be processed shortly"
}
Organisations
List Organisations
Returns a paginated list of organisations. Vendors see only their own organisation. Super admins with "View Any Organisation" permission see all organisations.
Headers
Query Parameters
Filter by organisation name (partial match).
Sort field. Allowed: id, name, created_at.
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/organisations?filter%5Bname%5D=Acme&sort=-id&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Acme Corp",
"friendly_name": "Acme",
"email": "hello@acme.com",
"phone_number": "+60123456789",
"pos_provider": null,
"ecommerce_provider": null,
"features": {
"loyalty": true,
"credits": false,
"tiering": false,
"ecommerce_integration": false
},
"subscription": {
"status": "active",
"is_manual": true,
"billing_period": "quarterly",
"plan_name": "[2026] Pro",
"current_period_end": "2026-10-16T23:06:08+08:00"
},
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Show Organisation
Headers
URL Parameters
The organisation ID.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/organisations/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Acme Corp",
"features": {
"loyalty": true,
"credits": false,
"tiering": false,
"ecommerce_integration": false
}
}
}
Update Organisation
Headers
URL Parameters
The organisation ID.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/organisations/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Acme Corp\",
\"friendly_name\": \"Acme\",
\"email\": \"hello@acme.com\",
\"phone_number\": \"+60123456789\"
}"
{
"data": {
"id": 1,
"name": "Updated Name"
},
"message": "Organisation updated successfully"
}
Subscriptions
Stripe subscriptions belonging to an organisation.
List Organisation Subscriptions
Returns a paginated list of Stripe subscriptions for the specified organisation. Only the organisation's own members can access this endpoint.
Headers
URL Parameters
The organisation ID.
Query Parameters
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/organisations/1/subscriptions?per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"type": "default",
"stripe_id": "sub_1ABC",
"stripe_status": "active",
"stripe_price": "price_1ABC",
"quantity": 1,
"trial_ends_at": null,
"ends_at": null,
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"total": 1
}
}
Invoices
Pixalink invoices issued to an organisation through Bukku (ADR-0029): the plan, one-time charges and other services.
List Organisation Invoices
Returns the organisation's Pixalink invoices, newest first, as Explore mirrors them from Bukku. Pixalink admins can read any organisation's invoices; anyone else only their own organisation's.
Headers
URL Parameters
The organisation ID.
Query Parameters
Comma-separated statuses: issued, partially_paid, paid, void.
Comma-separated categories: subscription, one_time, other.
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/organisations/1/invoices?filter%5Bstatus%5D=issued%2Cpartially_paid&filter%5Bcategory%5D=subscription&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 12,
"number": "INV-2210000467",
"share_url": "https://pixalink.bukku.my/l/dF6vaNuhUy",
"status": "issued",
"category": "subscription",
"amount_cents": 625468,
"balance_cents": 625468,
"currency": "MYR",
"issued_on": "2026-10-26",
"due_on": "2026-12-25",
"period_starts_on": null,
"period_ends_on": null,
"paid_at": null,
"share_index": 1,
"share_count": 1,
"billed_to": "Ghazal Mahel Associates Sdn Bhd",
"source": "imported",
"synced_at": "2026-11-02T04:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
POS Credits
List POS credits
Headers
Query Parameters
Filter by status (pending, adopted).
Filter by space ID.
Filter by ref_id.
Filter by date (YYYY-MM-DD).
Filter by amount with operators.
Sort field. Allowed: transaction_timestamp, amount, created_at.
Relationships to include (space).
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/posCredit?filter%5Bstatus%5D=adopted&filter%5Bspace_id%5D=1&filter%5Bref_id%5D=REF-123&filter%5Btransaction_timestamp%5D=2025-05-06&filter%5Bamount%5D=%3E50&sort=-created_at&include=space&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"ref_id": "CREDIT-12345",
"transaction_timestamp": "2025-05-06T14:30:00.000000Z",
"amount": "50.00",
"status": "adopted",
"pos_provider": "eats365",
"organisation_id": 1,
"space_id": 1,
"credit_id": 101,
"void_credit_id": null,
"payload": {
"terminal": "T001"
},
"created_at": "2025-05-06T14:30:01.000000Z",
"updated_at": "2025-05-06T14:30:01.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Create POS Credit
Ingests a POS credit record. If a customer is identified (via customer_id or phone_number), a credit wallet entry is created and the POS credit status is set to adopted. Without customer identification the record is stored as pending for later adoption.
- Positive amounts create a
Top Upcredit. - Negative amounts create a
Refundcredit.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/posCredit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ref_id\": \"REF-20250506-001\",
\"transaction_timestamp\": \"2025-05-06T14:30:00Z\",
\"amount\": 5000,
\"payload\": {
\"receipt_no\": \"RCP-001\",
\"terminal_id\": \"T01\"
},
\"space_id\": 1,
\"customer_id\": 42,
\"phone_number\": \"+60123456789\",
\"remarks\": \"Top-up via Eats365 POS\"
}"
{
"data": {
"id": 1,
"ref_id": "CREDIT-12345",
"transaction_timestamp": "2025-05-06T14:30:00.000000Z",
"amount": "50.00",
"status": "adopted",
"pos_provider": "eats365",
"organisation_id": 1,
"space_id": 1,
"credit_id": 101,
"void_credit_id": null,
"payload": {
"terminal": "T001"
},
"created_at": "2025-05-06T14:30:01.000000Z",
"updated_at": "2025-05-06T14:30:01.000000Z"
}
}
Void POS Credit
Voids an adopted POS credit record by creating a deduct entry in the customer's credit wallet.
Idempotency: Voiding an already-voided POS credit returns success without creating a duplicate entry.
Headers
URL Parameters
The ID of the POS credit to void.
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/posCredit/1/void" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 42,
\"remarks\": \"Voided per customer request\"
}"
{
"message": "POS credit voided successfully.",
"data": {
"id": 202,
"customer_id": 42,
"amount": 50,
"operation": "-",
"type": "Deduct",
"remarks": "Voided POS credit #1",
"created_at": "2025-05-06T15:00:00.000000Z"
}
}
POS Transaction
List POS transactions
Returns a paginated list of POS transactions for the authenticated organisation. Results can be filtered, sorted and paginated.
Headers
Query Parameters
Filter by transaction status.
Filter by space UUID.
Filter by transaction date (Y-m-d format).
Filter by minimum amount.
Filter by maximum amount.
Filter by reference ID.
Sort by column (prefixed with - for descending). Available options: transaction_time, amount, created_at.
Include related resources. Available options: space.
Page number.
Items per page (max 100).
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/posTransaction?filter%5Bstatus%5D=adopted&filter%5Bspace_id%5D=1&filter%5Btransaction_time%5D=2025-05-06&filter%5Bamount_min%5D=50&filter%5Bamount_max%5D=500&filter%5Bref_id%5D=TRX-123&sort=-transaction_time&include=space&page=1&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"ref_id": "TRX-12345678",
"transaction_time": "2025-05-06T14:30:00Z",
"amount": 150,
"status": "adopted",
"pos_provider": "provider_name",
"organisation_id": 1,
"created_at": "2025-05-06T14:35:00Z",
"updated_at": "2025-05-06T14:35:00Z",
"space": {
"id": "1",
"name": "Main Store",
"slug": "main-store"
}
}
],
"links": {
"first": "{{$baseUrl}}/pos-transactions?page=1",
"last": "{{$baseUrl}}/pos-transactions?page=5",
"prev": null,
"next": "{{$baseUrl}}/pos-transactions?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"path": "{{$baseUrl}}/pos-transactions",
"per_page": 15,
"to": 15,
"total": 75
}
}
Create a new POS transaction
This endpoint creates a new POS transaction in the system. If a customer identifier (customer_id or phone_number) is provided, the transaction will be automatically adopted and a corresponding transaction record will be created for the customer. Re-posting a ref_id within the same organisation returns the original transaction with HTTP 200 and records nothing new.
Partial Refunds: To process a partial refund, send a negative amount. Optionally provide the original_ref_id of the transaction being refunded. The refund will deduct proportional points from the customer's balance.
Blind Refunds: If no original_ref_id is provided with a negative amount (blind refund), points will be deducted using the formula: refund_amount × tier_multiplier (or 1:1 if customer has no tier).
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/posTransaction" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"space_id\": 1,
\"ref_id\": \"TRX-12345678\",
\"transaction_time\": \"2025-05-06T14:30:00Z\",
\"amount\": 15000,
\"payload\": \"{\\\"items\\\": [{\\\"name\\\": \\\"Product A\\\", \\\"quantity\\\": 2, \\\"price\\\": 7500}], \\\"payment_method\\\": \\\"credit_card\\\", \\\"terminal_id\\\": \\\"T001\\\"}\",
\"customer_id\": 42,
\"phone_number\": \"+60123456789\",
\"original_ref_id\": \"TRX-ORIGINAL-001\",
\"remarks\": \"2x Coffee, 1x Sandwich\"
}"
{
"data": {
"id": 1,
"ref_id": "TRX-12345678",
"transaction_time": "2025-05-06T14:30:00Z",
"amount": 150,
"status": "adopted",
"pos_provider": "provider_name",
"payload": {
"items": []
},
"remarks": "Original sale",
"is_refund": false,
"created_at": "2025-05-06T14:35:00Z",
"updated_at": "2025-05-06T14:35:00Z"
},
"message": "Transaction already recorded"
}
Void POS Transaction
Voids an adopted POS transaction and deducts the exact points that were earned. This generic endpoint works for all POS providers.
The void operation uses the linked transaction_id to deduct the exact amount of points that were earned, accounting for tier multipliers. For example:
- Customer with 2x Gold tier earns 200 points on $100 purchase
- Voiding deducts exactly 200 points (not 100)
Idempotency: Attempting to void the same transaction multiple times will return success but only create one void transaction.
Headers
URL Parameters
The ID of the POS transaction to void.
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/posTransaction/123/void" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 456,
\"remarks\": \"\\\"Transaction voided - customer request\\\"\"
}"
{
"message": "POS transaction voided successfully.",
"data": {
"id": 789,
"customer_id": 456,
"amount": 200,
"operation": "-",
"remarks": "Transaction voided from POS System (Ref: REF-12345)",
"created_at": "2025-10-25T14:30:00Z"
}
}
Paid Membership Types
List Paid Membership Types
Returns a paginated list of paid membership type catalog entries belonging to the authenticated user's organisation. Supports filtering and sorting via query parameters.
Headers
Query Parameters
Filter by active status.
Filter by membership type name (partial match).
Sort field and direction. Prefix with - for descending. Available fields: sort, name, created_at. Defaults to sort.
Number of records per page. Defaults to 15.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/paid_membership_types?filter%5Bis_active%5D=1&filter%5Bname%5D=Gold&sort=-created_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"organisation_id": 1,
"name": "VIP Gold",
"description": "Priority support and birthday rewards.",
"pricing_options": [
{
"cycle": "monthly",
"price": 3500
},
{
"cycle": "yearly",
"price": 35000
}
],
"benefits": [
{
"icon": "heroicon-o-star",
"heading": "Priority Support",
"description": "Get priority customer support"
}
],
"sort": 1,
"is_active": true,
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "...",
"per_page": 15,
"to": 1,
"total": 1
}
}
Show Paid Membership Type
Retrieves a single paid membership type by ID. Cross-organisation access returns 404.
Headers
URL Parameters
The ID of the paid membership type.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/paid_membership_types/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"organisation_id": 1,
"name": "VIP Gold",
"description": "Priority support and birthday rewards.",
"pricing_options": [
{
"cycle": "monthly",
"price": 3500
}
],
"benefits": [],
"sort": 1,
"is_active": true,
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
}
Payments
List Payments
Get a paginated list of payments and refunds belonging to the authenticated user's organisation. Results can be filtered, sorted and expanded with related data through query parameters.
Headers
Query Parameters
Filter by record type. Available values: payment, refund.
Filter by payment status code (e.g. 0 = pending, 1 = success, 2 = failed).
Filter by payment method (e.g. commerce_pay, manual, credit).
Filter by the transaction reference (your own POS/gateway reference id).
Filter by the fully-qualified class of what was paid for.
Filter by the customer who paid.
Filter by creation date with operators.
Filter by completion date with operators.
Sort field. Allowed: created_at, completed_at, amount. Use - for descending.
Comma-separated relationships to include. Allowed: payer, refunds, refundingPayment.
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/payments?filter%5Btype%5D=payment&filter%5Bstatus%5D=1&filter%5Bmethod%5D=commerce_pay&filter%5Breference_id%5D=POS-12345&filter%5Bpayable_type%5D=App%5CModels%5CReservation&filter%5Bcustomer_id%5D=42&filter%5Bcreated_at%5D=%3E2024-01-01&filter%5Bcompleted_at%5D=%3E2024-01-01&sort=-created_at&include=payer&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"type": "payment",
"method": "commerce_pay",
"reference_id": "TXN-1234567890",
"amount": 150,
"currency_code": "MYR",
"status": 1,
"is_manual": false,
"payment_type": null,
"source": null,
"attempted_at": "2025-01-01T00:00:00+00:00",
"completed_at": "2025-01-01T00:01:00+00:00",
"failed_at": null,
"failure_reason": null,
"created_at": "2025-01-01T00:00:00+00:00"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"per_page": 15,
"total": 1
}
}
Show Payment
Retrieve detailed information about a specific payment or refund.
Headers
URL Parameters
The ID of the payment.
Query Parameters
Comma-separated relationships to include. Allowed: payer, refunds, refundingPayment.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/payments/1?include=payer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"type": "payment",
"method": "commerce_pay",
"reference_id": "TXN-1234567890",
"amount": 150,
"currency_code": "MYR",
"status": 1,
"is_manual": false,
"payment_type": null,
"source": null,
"attempted_at": "2025-01-01T00:00:00+00:00",
"completed_at": "2025-01-01T00:01:00+00:00",
"failed_at": null,
"failure_reason": null,
"created_at": "2025-01-01T00:00:00+00:00"
}
}
Plans
List Plans
Returns a paginated list of active subscription plans, including their prices.
Headers
Query Parameters
Filter by plan name (partial match).
Sort field. Allowed: id, name, created_at.
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/plans?filter%5Bname%5D=Premium&sort=-id&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Premium",
"description": "Full access to all features",
"is_active": true,
"features": {
"loyalty_enabled": true,
"credits_enabled": true,
"tiering_enabled": true,
"max_spaces": 3,
"max_customers": 10000
},
"prices": [
{
"id": 1,
"currency": "MYR",
"billing_period": "monthly",
"amount": 350,
"stripe_price_id": "price_1ABC",
"is_active": true,
"description": null
}
],
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Show Plan
Headers
URL Parameters
The plan ID.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/plans/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Premium",
"features": {
"loyalty_enabled": true
},
"prices": []
}
}
Referral Programme
Your organisation's referral programme: what an invitee receives, the inviter's reward slots (the Nth referral pays slot N), and the condition that makes a referral claimable. An organisation has at most one programme.
List Referral Programmes
Returns your organisation's referral programme with its slots, as a list of at most one.
Headers
Query Parameters
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/referral_configurations?per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 62,
"invitee": {
"reward_id": null,
"points": 0,
"credit": 0
},
"slots": [
{
"id": 641,
"slot": 1,
"name": "Referral 1",
"reward_id": null,
"points": 0,
"credit": 0
},
{
"id": 642,
"slot": 2,
"name": "Referral 2",
"reward_id": null,
"points": 0,
"credit": 0
},
{
"id": 643,
"slot": 3,
"name": "Referral 3",
"reward_id": null,
"points": 0,
"credit": 10
}
],
"slot_consumption_trigger": "signup",
"claim_trigger": "signup",
"require_min_spending": false,
"min_spending": {
"condition": "cumulative",
"currency": "point",
"credit_type": null,
"amount": 3000
},
"notifications": {
"inviter_enabled": true,
"inviter_message": "<p>Thanks for referring {{INVITEE_NAME}}!</p>",
"claimable_enabled": false,
"claimable_message": null
},
"terms": "<p>Refer a friend and earn credits.</p>",
"referral_message": "Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}",
"created_at": "2025-12-23T11:12:34.000000Z",
"updated_at": "2026-11-02T08:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Referral Programme
Create your organisation's referral programme. Every field is optional: a new programme
defaults to 10 empty slots, no invitee reward, no minimum spending, and both triggers on
signup. Refused with a 422 if your organisation already has a programme.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/referral_configurations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"invitee\": {
\"reward_id\": 12,
\"points\": 0,
\"credit\": 0
},
\"inviter\": {
\"reward_id\": 13,
\"points\": 0,
\"credit\": 0
},
\"slot_count\": 10,
\"slot_consumption_trigger\": \"signup\",
\"claim_trigger\": \"signup\",
\"require_min_spending\": false,
\"min_spending\": {
\"condition\": \"cumulative\",
\"currency\": \"point\",
\"amount\": 3000,
\"credit_type\": \"Top Up\"
},
\"terms\": \"<p>Refer a friend and earn credits.<\\/p>\",
\"referral_message\": \"Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}\",
\"notifications\": {
\"inviter_enabled\": true,
\"inviter_message\": \"<p>{{INVITEE_NAME}} joined with your referral!<\\/p>\",
\"claimable_enabled\": false,
\"claimable_message\": \"<p>Your referral reward is ready to claim.<\\/p>\"
},
\"slots\": [
{
\"slot\": 2,
\"reward_id\": 22,
\"points\": 0,
\"credit\": 1
}
]
}"
{
"data": {
"id": 62,
"invitee": {
"reward_id": null,
"points": 0,
"credit": 0
},
"slots": [
{
"id": 641,
"slot": 1,
"name": "Referral 1",
"reward_id": null,
"points": 0,
"credit": 0
},
{
"id": 642,
"slot": 2,
"name": "Referral 2",
"reward_id": null,
"points": 0,
"credit": 0
},
{
"id": 643,
"slot": 3,
"name": "Referral 3",
"reward_id": null,
"points": 0,
"credit": 10
}
],
"slot_consumption_trigger": "signup",
"claim_trigger": "signup",
"require_min_spending": false,
"min_spending": {
"condition": "default",
"currency": "point",
"credit_type": "Top Up",
"amount": 1000
},
"notifications": {
"inviter_enabled": false,
"inviter_message": "<p>...</p>",
"claimable_enabled": false,
"claimable_message": "<p>...</p>"
},
"terms": "<p><strong>Terms and Conditions</strong></p>",
"referral_message": "Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}",
"created_at": "2026-11-02T08:00:00.000000Z",
"updated_at": "2026-11-02T08:00:00.000000Z"
}
}
Show Referral Programme
Retrieve your referral programme with its slots.
Headers
URL Parameters
The ID of the referral configuration.
The ID of the programme.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/referral_configurations/16" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 62,
"invitee": {
"reward_id": null,
"points": 0,
"credit": 0
},
"slots": [
{
"id": 641,
"slot": 1,
"name": "Referral 1",
"reward_id": null,
"points": 0,
"credit": 0
},
{
"id": 643,
"slot": 3,
"name": "Referral 3",
"reward_id": null,
"points": 0,
"credit": 10
}
],
"slot_consumption_trigger": "signup",
"claim_trigger": "signup",
"require_min_spending": false,
"min_spending": {
"condition": "cumulative",
"currency": "point",
"credit_type": null,
"amount": 3000
},
"notifications": {
"inviter_enabled": true,
"inviter_message": "<p>...</p>",
"claimable_enabled": false,
"claimable_message": null
},
"terms": "<p>Refer a friend and earn credits.</p>",
"referral_message": "Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}",
"created_at": "2025-12-23T11:12:34.000000Z",
"updated_at": "2026-11-02T08:00:00.000000Z"
}
}
Update Referral Programme
Change your referral programme. Only the fields you send are changed; slots not listed
in slots keep their reward. A slot that already has referrals cannot be removed by
lowering slot_count.
Headers
URL Parameters
The ID of the referral configuration.
The ID of the programme.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/referral_configurations/16" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"invitee\": {
\"reward_id\": 12,
\"points\": 0,
\"credit\": 0
},
\"inviter\": {
\"reward_id\": 13,
\"points\": 0,
\"credit\": 0
},
\"slot_count\": 10,
\"slot_consumption_trigger\": \"signup\",
\"claim_trigger\": \"signup\",
\"require_min_spending\": false,
\"min_spending\": {
\"condition\": \"cumulative\",
\"currency\": \"point\",
\"amount\": 3000,
\"credit_type\": \"Top Up\"
},
\"terms\": \"<p>Refer a friend and earn credits.<\\/p>\",
\"referral_message\": \"Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}\",
\"notifications\": {
\"inviter_enabled\": true,
\"inviter_message\": \"<p>{{INVITEE_NAME}} joined with your referral!<\\/p>\",
\"claimable_enabled\": false,
\"claimable_message\": \"<p>Your referral reward is ready to claim.<\\/p>\"
},
\"slots\": [
{
\"slot\": 2,
\"reward_id\": 22,
\"points\": 0,
\"credit\": 1
}
]
}"
{
"data": {
"id": 62,
"invitee": {
"reward_id": null,
"points": 0,
"credit": 0
},
"slots": [
{
"id": 643,
"slot": 3,
"name": "Referral 3",
"reward_id": null,
"points": 0,
"credit": 10
},
{
"id": 645,
"slot": 5,
"name": "Referral 5",
"reward_id": null,
"points": 0,
"credit": 20
}
],
"slot_consumption_trigger": "signup",
"claim_trigger": "signup",
"require_min_spending": false,
"min_spending": {
"condition": "cumulative",
"currency": "point",
"credit_type": null,
"amount": 3000
},
"notifications": {
"inviter_enabled": true,
"inviter_message": "<p>...</p>",
"claimable_enabled": false,
"claimable_message": null
},
"terms": "<p>Refer a friend and earn credits.</p>",
"referral_message": "Join me at {{SPACE_NAME}}: {{REFERRAL_LINK}}",
"created_at": "2025-12-23T11:12:34.000000Z",
"updated_at": "2026-11-02T08:30:00.000000Z"
}
}
Referrals
A referral links a new customer (the invitee) to the existing customer who brought them (the inviter). Each referral an inviter makes takes their next reward slot; once the referral is claimable, the inviter (or your system, via Claim) collects that slot's reward.
List Referrals
Get a paginated list of referrals in your organisation. Filter by inviter to see how many people a member has referred and which slot rewards are waiting to be claimed.
Headers
Query Parameters
Filter by the customer who made the referral.
Filter by the customer who was referred.
Filter by whether the referral's condition has been met.
Filter by creation time, optionally prefixed with an operator (>, >=, <, <=).
Sort field (created_at, claimed_at). Prefix with - for descending.
Include relationships (inviter, invitee, referralItem).
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/referrals?filter%5Binviter_customer_id%5D=42&filter%5Binvitee_customer_id%5D=43&filter%5Bis_claimable%5D=1&filter%5Bcreated_at%5D=%3E%3D2026-11-01&sort=-created_at&include=inviter%2Cinvitee&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"inviter_customer_id": 42,
"invitee_customer_id": 43,
"referral_item_id": 7,
"slot": 1,
"status": "claimable",
"is_claimable": true,
"claimed_at": null,
"created_at": "2026-11-02T10:00:00.000000Z",
"updated_at": "2026-11-02T10:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Link Referral
Record that a customer was referred by another customer. Create the new customer first with POST /api/v1/customers, then link them here. This runs the same referral flow as a customer-portal signup: the inviter takes their next reward slot, the invitee gets the programme's invitee reward, and the inviter is notified if that is switched on.
A customer can be referred only once. The request is refused with a 422, and nothing is changed, when the inviter is not your customer, the invitee was already referred, a customer refers themselves, you have no referral programme, or the inviter has used every slot.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/referrals" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"inviter_customer_id\": 42,
\"inviter_phone_number\": \"+60123456789\",
\"invitee_customer_id\": 43,
\"invitee_phone_number\": \"+60198765432\"
}"
{
"data": {
"id": 1,
"inviter_customer_id": 42,
"invitee_customer_id": 43,
"referral_item_id": 7,
"slot": 1,
"status": "claimable",
"is_claimable": true,
"claimed_at": null,
"created_at": "2026-11-02T10:00:00.000000Z",
"updated_at": "2026-11-02T10:00:00.000000Z"
}
}
Show Referral
Retrieve a single referral.
Headers
URL Parameters
The ID of the referral.
The ID of the referral.
Query Parameters
Include relationships (inviter, invitee, referralItem).
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/referrals/16?include=inviter%2Cinvitee" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"inviter_customer_id": 42,
"invitee_customer_id": 43,
"referral_item_id": 7,
"slot": 1,
"status": "claimed",
"is_claimable": true,
"claimed_at": "2026-11-03T09:00:00.000000Z",
"created_at": "2026-11-02T10:00:00.000000Z",
"updated_at": "2026-11-03T09:00:00.000000Z"
}
}
Claim Referral Reward
Pay the inviter the reward on the slot this referral took (its voucher, points and
credits), as if the inviter had tapped Claim in the customer portal. Credits are paid
as Referral credits. A referral can be claimed once, and only after its condition is
met (status claimable).
Headers
URL Parameters
The ID of the referral.
The ID of the referral to claim.
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/referrals/16/claim" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"space_id\": 1
}"
{
"data": {
"id": 1,
"inviter_customer_id": 42,
"invitee_customer_id": 43,
"referral_item_id": 7,
"slot": 3,
"status": "claimed",
"is_claimable": true,
"claimed_at": "2026-11-03T09:00:00.000000Z",
"created_at": "2026-11-02T10:00:00.000000Z",
"updated_at": "2026-11-03T09:00:00.000000Z"
}
}
Reward Validation
APIs for validating reward redemption codes
Validate Reward Code
Validates a 6-digit reward redemption code and returns validation status along with complete reward details. This endpoint is designed for cashiers and POS systems to verify reward codes before processing redemptions.
The validation process checks:
- Code format (must be exactly 6 digits)
- Code existence in the system
- Code expiration status
- Whether the code has already been used
- Whether the reward itself is already used or expired (CODE_ALREADY_USED / CODE_EXPIRED)
- Organisation-level multi-tenancy
- The outlet, when
space_idis given and the reward is restricted to selected outlets
The response includes the full reward object with properties field containing POS integration settings.
For iVend POS: Check reward.properties.ivend.enabled to determine if the reward can be processed.
Use reward.properties.ivend.amount to apply the discount amount.
Headers
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/customer_rewards/validate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"code\": \"123456\",
\"space_id\": 12,
\"organisation_id\": 123
}"
{
"valid": true,
"message": "Code is valid",
"data": {
"id": 101,
"status": "Pending",
"code": "123456",
"expired_at": "2024-12-31T23:59:59.000000Z",
"used_at": null,
"customer_id": 42,
"reward_id": 5,
"customer": {
"id": 42,
"name": "John Doe",
"phone_number": "+601234567890",
"email": "john@example.com",
"current_point": 2500,
"current_credits": 150
},
"reward": {
"id": 5,
"name": "Free Coffee",
"description": "Complimentary coffee of your choice",
"terms": "Valid at all outlets. One redemption per visit.",
"is_active": true,
"start_at": null,
"end_at": null,
"valid_days": 30,
"amount": 100,
"point_is_active": true,
"credit_is_active": false,
"credit_amount": 10.5,
"credit_earn_point": false,
"available_currency_types": [
"point"
],
"allow_customer_self_reward": true,
"is_one_time_reward": false,
"is_direct_link_accessible": false,
"is_redeemable": true,
"is_custom_valid_days": true,
"is_limit_total_availability": false,
"total_availability": null,
"total_redeemed": 15,
"cover": "gift",
"automations": [],
"notification_settings": {},
"properties": {
"ivend": {
"enabled": true,
"type": "amount",
"amount": 5
}
},
"created_at": "2024-01-15T08:30:00.000000Z",
"updated_at": "2024-02-10T10:45:00.000000Z"
}
}
}
Rewards
List Rewards
Returns a paginated list of rewards belonging to the authenticated user's organisation spaces.
Supports filtering, sorting and relationship inclusion through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- space
- customerRewards
- rewardVouchers
- inviterReferralItem
- inviteeReferralItem
- rewardBundleItems
- pendingRewardVouchers
- media
Filter by space ID.
Filter by active status.
Filter by redeemable status.
Filter by one-time reward status.
Filter by self-reward permission.
Filter by point redemption availability.
Filter by credit redemption availability.
Filter by availability (considers active status and date range).
Filter by reward name (partial match).
Sort field and direction. Note: Prefix with - for descending order.
Available sort fields:
- name
- start_at
- end_at
- created_at
- amount
Number of records per page. Defaults to 15.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/rewards?include=space%2Cmedia&filter%5Bspace_id%5D=1&filter%5Bis_active%5D=1&filter%5Bis_redeemable%5D=1&filter%5Bis_one_time_reward%5D=&filter%5Ballow_customer_self_reward%5D=1&filter%5Bpoint_is_active%5D=1&filter%5Bcredit_is_active%5D=1&filter%5Bavailable%5D=1&filter%5Bname%5D=Birthday&sort=-created_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Birthday Reward",
"description": "Special reward for customer birthdays",
"terms": "Valid for 30 days from issue",
"is_active": true,
"start_at": "2025-01-01T00:00:00.000000Z",
"end_at": "2025-12-31T23:59:59.000000Z",
"valid_days": 30,
"amount": 1000,
"credit_amount": 10.5,
"allow_customer_self_reward": false,
"is_one_time_reward": true,
"is_direct_link_accessible": false,
"is_redeemable": true,
"is_custom_valid_days": true,
"is_limit_total_availability": true,
"total_availability": 100,
"total_redeemed": 0,
"cover": "gift",
"automations": [],
"notification_settings": {
"new_reward": {
"is_enabled": true,
"message": "You've received a birthday reward!"
}
},
"properties": {
"ivend": {
"enabled": true,
"type": "amount",
"amount": 10
}
},
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
],
"links": {
"first": "{{$baseUrl}}/api/rewards?page=1",
"last": "{{$baseUrl}}/api/rewards?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "{{$baseUrl}}/api/rewards",
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Reward
Creates a new reward in the system.
The reward will be associated with the specified space in the authenticated user's organisation.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/rewards" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Birthday Reward\",
\"description\": \"Special reward for customer birthdays\",
\"terms\": \"Valid for 30 days from issue\",
\"space_id\": 1,
\"reward_category_id\": 1,
\"is_active\": true,
\"start_at\": \"2025-01-01\",
\"end_at\": \"2025-12-31\",
\"is_redeemable\": true,
\"is_custom_valid_days\": true,
\"valid_days\": 30,
\"amount\": 1000,
\"point_is_active\": true,
\"credit_is_active\": true,
\"credit_amount\": 10.5,
\"credit_earn_point\": false,
\"allow_customer_self_reward\": true,
\"is_one_time_reward\": true,
\"is_direct_link_accessible\": false,
\"is_limit_total_availability\": true,
\"total_availability\": 100,
\"cover\": \"gift\",
\"notification_settings\": {
\"new_reward\": {
\"is_enabled\": false,
\"message\": \"Hi {{NAME}}, you have received a new reward from {{SPACE_NAME}}!\"
},
\"expired_reward\": {
\"is_enabled\": true,
\"message\": \"Hi {{NAME}}, your reward has expired.\"
},
\"expiring_reward\": {
\"is_enabled\": true,
\"message\": \"Hi {{NAME}}, your reward will expire soon!\",
\"send_notification_before\": \"7\"
}
}
}"
{
"data": {
"id": 1,
"name": "Birthday Reward",
"description": "Special reward for customer birthdays",
"terms": "Valid for 30 days from issue",
"is_active": true,
"start_at": "2025-01-01T00:00:00.000000Z",
"end_at": "2025-12-31T23:59:59.000000Z",
"valid_days": 30,
"amount": 1000,
"credit_amount": 10.5,
"allow_customer_self_reward": false,
"is_one_time_reward": true,
"is_direct_link_accessible": false,
"is_redeemable": true,
"is_custom_valid_days": true,
"is_limit_total_availability": true,
"total_availability": 100,
"total_redeemed": 0,
"cover": "gift",
"automations": [],
"notification_settings": {
"new_reward": {
"is_enabled": true,
"message": "You've received a birthday reward!"
}
},
"properties": {
"ivend": {
"enabled": true,
"type": "amount",
"amount": 10
}
},
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
},
"message": "Reward created successfully"
}
Show Reward Details
Retrieves detailed information about a specific reward, including any requested relationships.
Headers
URL Parameters
The ID of the reward.
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- space
- customerRewards
- rewardVouchers
- inviterReferralItem
- inviteeReferralItem
- rewardBundleItems
- pendingRewardVouchers
- media
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/rewards/1?include=space%2Cmedia" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Birthday Reward",
"description": "Special reward for customer birthdays",
"terms": "Valid for 30 days from issue",
"is_active": true,
"start_at": "2025-01-01T00:00:00.000000Z",
"end_at": "2025-12-31T23:59:59.000000Z",
"valid_days": 30,
"amount": 1000,
"credit_amount": 10.5,
"allow_customer_self_reward": false,
"is_one_time_reward": true,
"is_direct_link_accessible": false,
"is_redeemable": true,
"is_custom_valid_days": true,
"is_limit_total_availability": true,
"total_availability": 100,
"total_redeemed": 0,
"cover": "gift",
"automations": [],
"notification_settings": {
"new_reward": {
"is_enabled": true,
"message": "You've received a birthday reward!"
}
},
"properties": {
"ivend": {
"enabled": true,
"type": "amount",
"amount": 10
}
},
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
}
Update Reward
Updates an existing reward's information.
All fields are optional.
Headers
URL Parameters
The ID of the reward.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/rewards/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Birthday Reward\",
\"description\": \"Special reward for customer birthdays\",
\"terms\": \"Valid for 30 days from issue\",
\"space_id\": 1,
\"reward_category_id\": 1,
\"is_active\": true,
\"start_at\": \"2025-01-01\",
\"end_at\": \"2025-12-31\",
\"is_redeemable\": true,
\"is_custom_valid_days\": true,
\"valid_days\": 30,
\"amount\": 1000,
\"point_is_active\": true,
\"credit_is_active\": true,
\"credit_amount\": 10.5,
\"credit_earn_point\": false,
\"allow_customer_self_reward\": true,
\"is_one_time_reward\": true,
\"is_direct_link_accessible\": false,
\"is_limit_total_availability\": true,
\"total_availability\": 100,
\"cover\": \"gift\",
\"notification_settings\": {
\"new_reward\": {
\"is_enabled\": false,
\"message\": \"architecto\"
},
\"expired_reward\": {
\"is_enabled\": true,
\"message\": \"Hi {{NAME}}, your reward has expired.\"
},
\"expiring_reward\": {
\"is_enabled\": true,
\"message\": \"Hi {{NAME}}, your reward will expire soon!\",
\"send_notification_before\": \"7\"
}
}
}"
{
"data": {
"id": 1,
"name": "Birthday Reward",
"description": "Special reward for customer birthdays",
"terms": "Valid for 30 days from issue",
"is_active": true,
"start_at": "2025-01-01T00:00:00.000000Z",
"end_at": "2025-12-31T23:59:59.000000Z",
"valid_days": 30,
"amount": 1000,
"credit_amount": 10.5,
"allow_customer_self_reward": false,
"is_one_time_reward": true,
"is_direct_link_accessible": false,
"is_redeemable": true,
"is_custom_valid_days": true,
"is_limit_total_availability": true,
"total_availability": 100,
"total_redeemed": 0,
"cover": "gift",
"automations": [],
"notification_settings": {
"new_reward": {
"is_enabled": true,
"message": "You've received a birthday reward!"
}
},
"properties": {
"ivend": {
"enabled": true,
"type": "amount",
"amount": 10
}
},
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
},
"message": "Reward updated successfully"
}
Delete Reward
Deletes a reward from the system.
Only rewards that haven't been assigned to any customers can be deleted.
Headers
URL Parameters
The ID of the reward.
curl --request DELETE \
"https://explore.pixalink.io/api/rewards/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" [Empty response]
Reward Voucher
Reward vouchers are a pool of codes for a reward, such as imported partner or e-commerce voucher codes.
Use /api/rewards/{reward_id}/vouchers to stock and manage that pool. A code can exist before it is assigned to anyone.
When issued, the pool entry links to a customer reward: the record of a specific customer's entitlement to the reward.
For example, "RM10 partner voucher" is the reward definition; PARTNER-ABC is a code in its voucher pool;
Sarah's issued RM10 reward is a customer reward. The voucher ID and customer reward ID identify different records.
For POS checkout, use Customer Rewards to find and redeem the customer's issued reward. Standard Pixalink discounts and free-item rewards can have customer rewards without any imported voucher pool. Compare rewards, customer rewards, and voucher codes before choosing an endpoint.
Pool statuses are Pending, Reserved, Active, Expired, and Used.
A pool entry's Pending status means it is awaiting assignment; a customer reward's Pending status means it has not been used.
List reward vouchers
Get a paginated list of vouchers for a specific reward.
Headers
URL Parameters
The ID of the reward.
Body Parameters
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/rewards/16/vouchers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"Active\",
\"search\": \"REWARD123\",
\"page\": 1,
\"per_page\": 15
}"
{
"data": [
{
"id": 1,
"code": "REWARD123",
"status": "Pending",
"expired_at": "2024-12-31T23:59:59Z",
"given_at": null,
"used_at": null,
"customer_reward": {
"customer": {
"id": 1,
"name": "John Doe",
"phone_number": "+1234567890"
}
}
}
],
"links": {
"first": "{{$baseUrl}}/api/rewards/{{reward_id}}/vouchers?page=1",
"last": "{{$baseUrl}}/api/rewards/{{reward_id}}/vouchers?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 1
}
}
Create reward voucher
Creates a reward voucher for a specific reward. The voucher is initially created in a pending status, which means it has been generated but not yet assigned. The voucher will remain in this state until it is given to a recipient or further processed.
Headers
URL Parameters
The ID of the reward.
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/rewards/16/vouchers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"code\": \"REWARD123XYZ\",
\"expired_at\": \"2024-12-31T23:59:59Z\"
}"
{
"id": 1,
"code": "REWARD123",
"status": "Pending",
"expired_at": "2024-12-31T23:59:59Z",
"given_at": null,
"used_at": null
}
Show reward voucher details
Retrieve detailed information about a specific reward voucher. This endpoint allows fetching a single voucher with optional related resources.
Headers
URL Parameters
The unique identifier of the reward.
The unique identifier of the voucher.
Query Parameters
Optional related resources to include. Possible values: customerReward, customerReward.customer, reward
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/rewards/1/vouchers/42?include=customerReward%2Creward" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"id": 1,
"code": "REWARD123",
"status": "Active",
"expired_at": "2024-12-31T23:59:59Z",
"given_at": "2024-02-09T10:00:00Z",
"used_at": null,
"customer_reward": {
"id": 12,
"status": "Pending"
},
"reward": {
"id": 1,
"name": "Loyalty Discount",
"description": "10% off next purchase"
}
}
Update reward voucher status
Update the status of a specific voucher.
Headers
URL Parameters
The ID of the reward.
The ID of the voucher.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/rewards/16/vouchers/16" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"used\"
}"
{
"id": 1,
"code": "REWARD123",
"status": "Used",
"expired_at": "2024-12-31T23:59:59Z",
"given_at": "2024-02-09T10:00:00Z",
"used_at": "2024-02-09T12:00:00Z"
}
Delete reward voucher
Delete a specific voucher.
Headers
URL Parameters
The ID of the reward.
The ID of the voucher.
curl --request DELETE \
"https://explore.pixalink.io/api/rewards/16/vouchers/16" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" [Empty response]
Bulk Update Reward Vouchers
Updates the status of multiple reward vouchers asynchronously. The operation is queued as a background job and processed in chunks of 100 records. This endpoint is rate limited to 10 requests per minute.
Headers
URL Parameters
The ID of the reward these vouchers belong to.
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/rewards/1/vouchers/bulk-update" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"voucher_codes\": [
\"REWARD123\"
],
\"voucher_ids\": [
1
],
\"status\": \"Used\"
}"
{
"message": "Bulk voucher update has been queued and will be processed shortly",
"updated_count": 3
}
Bulk import vouchers
Import multiple vouchers for a reward asynchronously. The operation is queued and processed in chunks of 100 records. Limited to 10,000 vouchers per request and rate limited to 10 requests per minute.
Headers
URL Parameters
The ID of the reward.
Body Parameters
curl --request POST \
"https://explore.pixalink.io/api/rewards/16/vouchers/bulk-import" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"vouchers\": [
{
\"code\": \"REWARD123\",
\"expired_at\": \"2024-12-31T23:59:59Z\"
}
],
\"auto_reassign\": false
}"
{
"message": "Bulk voucher import has been queued and will be processed shortly"
}
Roles
List Roles
Returns a paginated list of all available roles.
Headers
Query Parameters
Filter by role name (partial match).
Sort field. Allowed: id, name, created_at.
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/roles?filter%5Bname%5D=Admin&sort=-id&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Super Admin",
"guard_name": "web",
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Show Role
Headers
URL Parameters
The role ID.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/roles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Admin",
"guard_name": "web"
}
}
Spaces
List Spaces
Returns a paginated list of spaces belonging to the authenticated user's organisation.
Supports filtering, sorting and relationship inclusion through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- category (Space category details)
- address (Physical address details)
Filter by visibility status. Available options:
- public (Listed and viewable by anyone)
- private (Not listed, viewable with link)
- hidden (Not listed, cannot be searched)
- draft (Not listed, cannot be searched)
Filter by category ID.
Filter by space name (partial match).
Filter by space description (partial match).
Filter by space email (partial match).
Filter by organisation ID.
Sort field and direction. Available fields:
- name (Sort by space name)
- created_at (Sort by creation date)
- updated_at (Sort by last update)
- visits (Sort by number of visits) Default: -created_at
Number of records per page. Default: 15.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/spaces?include=category%2Caddress&filter%5Bvisibility%5D=public&filter%5Bcategory_id%5D=1&filter%5Bname%5D=Coworking&filter%5Bdescription%5D=modern&filter%5Bemail%5D=space%40example.com&filter%5Borganisation_id%5D=1&sort=-visits&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
"name": "Modern Coworking Space",
"slug": "modern-coworking-space",
"matterport_model_id": null,
"description": "A modern coworking space in the heart of the city",
"visibility": "public",
"email": "space@example.com",
"phone_number": "+60123456789",
"website": "{{$baseUrl}}/spaces/modern-coworking",
"social_media": [
{
"name": "Twitter",
"username": "@modernspace"
},
{
"name": "Facebook",
"username": "modernspacekl"
}
],
"organisation_id": 1,
"category_id": 2,
"visits": 1250,
"created_at": "2024-01-15T08:00:00Z",
"updated_at": "2024-02-08T14:30:00Z",
"deleted_at": null,
"address": {
"id": 1,
"address_line_1": "123 Jalan Sultan Ismail",
"address_line_2": "Level 23",
"postal_code": "50250",
"city": "Kuala Lumpur",
"state": "Wilayah Persekutuan",
"country": "Malaysia"
},
"category": {
"id": 2,
"name": "Coworking Space",
"slug": "coworking-space"
},
"links": {
"public_url": "{{$baseUrl}}/spaces/modern-coworking-space"
}
},
{
"id": 2,
"name": "Creative Studio",
"slug": "creative-studio",
"matterport_model_id": "abc123xyz",
"description": "A creative studio space perfect for photographers and content creators",
"visibility": "public",
"email": "studio@example.com",
"phone_number": "+60123456790",
"website": "{{$baseUrl}}/spaces/creative-studio",
"social_media": [
{
"name": "Instagram",
"username": "@creativestudiomy"
}
],
"organisation_id": 1,
"category_id": 3,
"visits": 890,
"created_at": "2024-01-20T10:00:00Z",
"updated_at": "2024-02-07T16:45:00Z",
"deleted_at": null,
"address": {
"id": 2,
"address_line_1": "45 Jalan Telawi",
"address_line_2": null,
"postal_code": "59100",
"city": "Bangsar",
"state": "Kuala Lumpur",
"country": "Malaysia"
},
"category": {
"id": 3,
"name": "Studio Space",
"slug": "studio-space"
},
"links": {
"public_url": "{{$baseUrl}}/spaces/creative-studio"
}
}
],
"links": {
"first": "{{$baseUrl}}/api/v1/spaces?page=1",
"last": "{{$baseUrl}}/api/v1/spaces?page=5",
"prev": null,
"next": "{{$baseUrl}}/api/v1/spaces?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"path": "{{$baseUrl}}/api/v1/spaces",
"per_page": 15,
"to": 15,
"total": 68
}
}
Create Space
Creates a new space in the system.
The space will be associated with the authenticated user's organisation.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/spaces" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Modern Coworking Space\",
\"description\": \"A modern coworking space in the heart of the city\",
\"visibility\": \"Public\",
\"email\": \"space@example.com\",
\"phone_number\": \"+60123456789\",
\"website\": \"{{$baseUrl}}\",
\"category_id\": 1,
\"social_media\": [
\"architecto\"
],
\"address\": [
\"architecto\"
],
\"tags\": [
\"Coworking\",
\"24\\/7\"
],
\"classification\": [
\"Premium\",
\"Featured\"
]
}"
{
"data": {
"id": 1,
"uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
"name": "Modern Coworking Space",
"slug": "modern-coworking-space",
"matterport_model_id": null,
"description": "A modern coworking space in the heart of the city offering flexible workspace solutions for professionals and teams",
"visibility": "public",
"email": "space@example.com",
"phone_number": "+60123456789",
"website": "https://pixalink.io/spaces/modern-coworking",
"social_media": [
{
"name": "Twitter",
"username": "@modernspace"
},
{
"name": "Facebook",
"username": "modernspacekl"
},
{
"name": "Instagram",
"username": "@modernspace.kl"
}
],
"organisation_id": 1,
"category_id": 2,
"visits": 0,
"created_at": "2024-02-08T15:00:00Z",
"updated_at": "2024-02-08T15:00:00Z",
"deleted_at": null,
"address": {
"id": 1,
"address_line_1": "123 Jalan Sultan Ismail",
"address_line_2": "Level 23",
"postal_code": "50250",
"city": "Kuala Lumpur",
"state": "Wilayah Persekutuan",
"country": "Malaysia"
},
"links": {
"public_url": "{{$baseUrl}}/spaces/modern-coworking-space"
}
}
}
Show Space Details
Retrieves detailed information about a specific space, including any requested relationships.
Headers
URL Parameters
The ID of the space.
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- category
- address
- activeCalendars
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/spaces/1?include=category%2Caddress" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
"name": "Modern Coworking Space",
"slug": "modern-coworking-space",
"matterport_model_id": null,
"description": "A modern coworking space in the heart of the city",
"visibility": "public",
"email": "space@example.com",
"phone_number": "+60123456789",
"website": "{{$baseUrl}}",
"social_media": [
{
"name": "Twitter",
"username": "@modernspace"
}
],
"tags": [
"Coworking",
"24/7"
],
"classification": [
"Premium",
"Featured"
],
"category_id": 1,
"organisation_id": 1,
"visits": 150,
"created_at": "2024-02-02T12:00:00Z",
"updated_at": "2024-02-02T12:00:00Z",
"address": {
"id": 1,
"address_line_1": "123 Main Street",
"address_line_2": "Suite 45",
"postal_code": "50450",
"city": "Petaling Jaya",
"state": "Selangor",
"country": "Malaysia"
},
"media": {
"preview": {
"url": "{{$baseUrl}}/media/preview.jpg",
"type": "image"
},
"featured_image": {
"url": "{{$baseUrl}}/media/featured.jpg"
},
"gallery": [
{
"url": "{{$baseUrl}}/media/gallery1.jpg"
}
],
"logo": {
"url": "{{$baseUrl}}/media/logo.jpg"
}
}
}
}
Update Space
Updates an existing space's information.
All fields are optional.
Omitted fields will retain their current values.
Headers
URL Parameters
The ID of the space.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/spaces/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Modern Coworking Space\",
\"description\": \"A modern coworking space in the heart of the city\",
\"visibility\": \"Public\",
\"email\": \"space@example.com\",
\"phone_number\": \"architecto\",
\"website\": \"{{$baseUrl}}\",
\"category_id\": 1,
\"social_media\": [
\"architecto\"
],
\"address\": [
\"architecto\"
],
\"tags\": [
\"Coworking\",
\"24\\/7\"
],
\"classification\": [
\"Premium\",
\"Featured\"
]
}"
{
"data": {
"id": 1,
"uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
"name": "Modern Coworking Space",
"slug": "modern-coworking-space",
"matterport_model_id": null,
"description": "A modern coworking space in the heart of the city",
"visibility": "public",
"email": "space@example.com",
"phone_number": "+60123456789",
"website": "{{$baseUrl}}",
"social_media": [
{
"name": "Twitter",
"username": "@modernspace"
}
],
"tags": [
"Coworking",
"24/7"
],
"classification": [
"Premium",
"Featured"
],
"category_id": 1,
"organisation_id": 1,
"visits": 150,
"created_at": "2024-02-02T12:00:00Z",
"updated_at": "2024-02-02T12:00:00Z"
}
}
Delete Space
Deletes a space and all its associated data including:
- Address
- Media (preview, gallery, logo)
- Tags and classifications
- POS integration settings
Headers
URL Parameters
The ID of the space.
curl --request DELETE \
"https://explore.pixalink.io/api/spaces/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" [Empty response]
Transactions
List Transactions
Get a paginated list of transactions for the organisation.
Headers
Query Parameters
Filter by customer ID.
Filter by transaction type. Available types:
- Purchase: Points earned from purchases
- Review: Points earned from reviews
- Referral: Points earned from referrals
- Earn Point: Points recorded manually by staff
- Stamp: Points earned from a stamp card
- Point Reward Redeem: Points spent on reward redemption
- Point Conversion: Points spent as payment at the POS (Eats365)
- Manual Deduction: Points deducted by hand by staff
- Void: Points reversed when a POS sale is voided
- Adjustment: System correction, e.g. an invoice amended down
- Refund: Points returned when a purchase is refunded
- Revert: Points reversed when an earn is voided
- Expired: System-generated marker deducting points that reached their expiry Types containing a space must be URL-encoded (Point%20Reward%20Redeem).
Filter by space ID.
Filter by point amount with operators (>, <, =).
Filter by purchase amount in cents with operators (>, <, =). RM50 is 5000.
Filter by creation time with operators (>, >=, <, <=, =, <>); combine two with a comma for a range, such as >=2024-01-01,<2024-02-01. A bare date means midnight. A value ending in Z or an offset such as +08:00 (URL-encode + as %2B) is converted for you; a value without one is read in the server's local time.
Return only transactions changed after (or before) a moment, with the same operators and formats as filter[created_at]. To sync incrementally, pass the time your previous sync started (or the latest updated_at you received).
Filter by the date the points expire, with operators. Past dates find points already expired; null for transactions that never expire.
Sort field (created_at, amount, expired_at). Use -field for descending.
Include relationships (customer, reward, space, customerRewards).
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/transactions?filter%5Bcustomer_id%5D=1&filter%5Btype%5D=Expired&filter%5Bspace_id%5D=1&filter%5Bamount%5D=%3E100&filter%5Bpurchase_amount%5D=%3E5000&filter%5Bcreated_at%5D=%3E%3D2024-01-01&filter%5Bupdated_at%5D=%3E2026-11-02T20%3A30%3A00Z&filter%5Bexpired_at%5D=%3C2024-01-01&sort=-created_at&include=customer%2Creward%2CcustomerRewards&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"amount": 1000,
"valid_amount": 1000,
"purchase_amount": 1234.56,
"operation": "+",
"type": "Purchase",
"remarks": "Purchase at Store #123",
"customer_id": 1,
"space_id": 1,
"reward_id": null,
"custom_properties": {
"purchase_amount": 1234.56,
"receipt_number": "R12345"
},
"expired_at": "2024-02-10T23:59:59.000000Z",
"created_at": "2024-02-09T10:00:00.000000Z",
"updated_at": "2024-02-09T10:00:00.000000Z",
"customer": {
"id": 1,
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"current_point": 2500,
"current_credits": 150
}
},
{
"id": 2,
"amount": 500,
"valid_amount": 500,
"operation": "-",
"type": "Point_Reward_Redeem",
"remarks": "Reward: Free Coffee",
"customer_id": 1,
"space_id": 1,
"reward_id": 5,
"custom_properties": null,
"expired_at": null,
"created_at": "2024-02-08T15:30:00.000000Z",
"updated_at": "2024-02-08T15:30:00.000000Z",
"reward": {
"id": 5,
"name": "Free Coffee",
"amount": 500,
"description": "Redeem a free coffee at any of our locations"
},
"customerRewards": [
{
"id": 1,
"status": "Used",
"code": null,
"expired_at": "2024-02-08T15:30:00.000000Z",
"used_at": "2024-02-08T15:30:00.000000Z",
"customer_id": 1,
"reward_id": 5
}
]
}
],
"links": {
"first": "{{$baseUrl}}/api/v1/transactions?page=1",
"last": "{{$baseUrl}}/api/v1/transactions?page=5",
"prev": null,
"next": "{{$baseUrl}}/api/v1/transactions?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/api/v1/transactions?page=1",
"label": "1",
"active": true
},
{
"url": "{{$baseUrl}}/api/v1/transactions?page=2",
"label": "2",
"active": false
}
],
"path": "{{$baseUrl}}/api/v1/transactions",
"per_page": 15,
"to": 15,
"total": 68
}
}
Create Transaction
Creates a new transaction record for tracking customer points/rewards. If no existing customer is found, a new customer will be automatically created with the provided phone number. Key features:
- Points are multiplied by the customer's tier multiplier if applicable
- Points may expire based on organisation settings
- Handles referral tracking and rewards
- Sends notifications if enabled in organisation settings
- Can mark linked customer rewards as used during transaction
Idempotency: when custom_properties.invoice_id is supplied, the earn is idempotent
per customer. Re-posting the same invoice_id for the same customer returns the
existing earn with HTTP 200 (instead of creating a duplicate). A freshly created earn
returns HTTP 201. Requests without invoice_id always create a new earn.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_id\": 1,
\"phone_number\": \"+60123456789\",
\"amount\": 1000,
\"space_id\": 1,
\"remarks\": \"Purchase at Store #123\",
\"custom_properties\": {
\"invoice_id\": \"INV-1001\",
\"purchase_amount\": 1234.56
},
\"customer_reward_ids\": [
1,
2,
3
]
}"
{
"data": {
"id": 1,
"amount": 1000,
"valid_amount": 1000,
"purchase_amount": 1234.56,
"operation": "+",
"type": "Purchase",
"remarks": "Purchase at Store #123",
"customer_id": 1,
"space_id": 1,
"custom_properties": {
"invoice_id": "INV-1001",
"purchase_amount": 1234.56
},
"expired_at": "2024-02-10T23:59:59.000000Z",
"created_at": "2024-02-09T10:00:00.000000Z",
"updated_at": "2024-02-09T10:00:00.000000Z"
}
}
Get Transaction Details
Retrieve detailed information about a specific transaction.
Headers
URL Parameters
The ID of the transaction.
Query Parameters
Relationships to include (customer, reward, space, customerRewards).
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/transactions/1?include=customer%2Creward%2CcustomerRewards" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"amount": 1000,
"valid_amount": 1000,
"purchase_amount": 1234.56,
"operation": "+",
"type": "Purchase",
"remarks": "Purchase at Store #123",
"customer_id": 1,
"space_id": 1,
"reward_id": null,
"expired_at": "2024-12-31T23:59:59.000000Z",
"created_at": "2024-02-09T10:00:00.000000Z",
"updated_at": "2024-02-09T10:00:00.000000Z"
}
}
Users
List Users
Returns a paginated list of users belonging to the authenticated user's organisation.
Headers
Query Parameters
Filter by user name (partial match).
Filter by email (partial match).
Sort field. Allowed: id, name, created_at.
Records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/users?filter%5Bname%5D=Alice&filter%5Bemail%5D=alice%40example.com&sort=-id&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Alice Tan",
"email": "alice@acme.com",
"organisation_id": 1,
"roles": [
"Super Admin"
],
"last_login_at": "2024-06-01T08:00:00.000000Z",
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 15,
"to": 1,
"total": 1
}
}
Show User
Headers
URL Parameters
The user ID.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/users/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Alice",
"email": "alice@example.com"
}
}
Calendars
List Calendars
Returns a paginated list of calendars belonging to the authenticated user's organisation spaces.
Supports filtering, sorting and relationship inclusion through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- space
- reservations
Filter by space ID.
Filter by active status.
Filter by visibility. Must be one of: Public, Private.
Filter by calendar name (partial match).
Sort field and direction. Note: Prefix with - for descending order.
Available sort fields:
- name
- created_at
- updated_at
Number of records per page. Defaults to 15.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/calendars?include=space%2Creservations&filter%5Bspace_id%5D=1&filter%5Bis_active%5D=1&filter%5Bvisibility%5D=Public&filter%5Bname%5D=Meeting+Room&sort=-created_at&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Meeting Room A",
"slug": "meeting-room-a",
"description": "Large meeting room for up to 20 people",
"is_active": true,
"space_id": 1,
"visibility": "Public",
"min_capacity": 1,
"max_capacity": 20,
"is_required_approval": false,
"is_auto_approval": true,
"cancel_before_minutes": 60,
"book_before_minutes": 30,
"reminder_minutes": 15,
"crm_auto_import": true,
"is_unavailable_timeslots_visible": false,
"is_qr_code_visible": true,
"default_timeslots": {
"0": [],
"1": [
{
"id": "9b1f6c2e-4a5d-4e8b-9c3f-2d7a1e6b5c40",
"day": "monday",
"start_at": "09:00 AM",
"title": "Monday",
"timeslot": "09:00 AM - 10:00 AM",
"available": "10"
}
],
"2": [],
"3": [],
"4": [],
"5": [],
"6": []
},
"block_dates": [],
"notification_settings": {
"new_reservation": {
"enabled": true,
"message": "Your reservation has been confirmed"
}
},
"custom_properties": {},
"channels": [
"WhatsApp",
"Sms"
],
"terms": "Please arrive 5 minutes before your scheduled time",
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
],
"links": {
"first": "{{$baseUrl}}/api/calendars?page=1",
"last": "{{$baseUrl}}/api/calendars?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "{{$baseUrl}}/api/calendars",
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Calendar
Creates a new calendar in the system.
The calendar will be associated with the specified space in the authenticated user's organisation.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/calendars" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Meeting Room A\",
\"slug\": \"meeting-room-a\",
\"description\": \"Large meeting room for up to 20 people\",
\"space_id\": 1,
\"is_active\": true,
\"visibility\": \"Public\",
\"min_capacity\": 1,
\"max_capacity\": 20,
\"is_required_approval\": false,
\"is_auto_approval\": true,
\"cancel_before_minutes\": 60,
\"book_before_minutes\": 30,
\"is_max_advance_booking_enabled\": false,
\"max_advance_booking_days\": 30,
\"reminder_minutes\": 15,
\"crm_auto_import\": true,
\"is_unavailable_timeslots_visible\": false,
\"is_qr_code_visible\": true,
\"default_timeslots\": [
\"architecto\"
],
\"block_dates\": [
{
\"data\": {
\"date\": \"2027-01-04\",
\"start_date\": \"2027-02-01\",
\"end_date\": \"2027-02-03\",
\"timeslot_id\": [
\"architecto\"
]
}
}
],
\"notification_settings\": {
\"new_reservation\": {
\"enabled\": true,
\"message\": \"Your reservation has been confirmed\"
}
},
\"custom_properties\": [],
\"channels\": [
\"WhatsApp\",
\"Sms\"
],
\"terms\": \"Please arrive 5 minutes before your scheduled time\"
}"
{
"data": {
"id": 1,
"name": "Meeting Room A",
"slug": "meeting-room-a",
"description": "Large meeting room for up to 20 people",
"is_active": true,
"space_id": 1,
"visibility": "Public",
"min_capacity": 1,
"max_capacity": 20,
"is_required_approval": false,
"is_auto_approval": true,
"cancel_before_minutes": 60,
"book_before_minutes": 30,
"reminder_minutes": 15,
"crm_auto_import": true,
"is_unavailable_timeslots_visible": false,
"is_qr_code_visible": true,
"default_timeslots": {
"0": [],
"1": [
{
"id": "9b1f6c2e-4a5d-4e8b-9c3f-2d7a1e6b5c40",
"day": "monday",
"start_at": "09:00 AM",
"title": "Monday",
"timeslot": "09:00 AM - 10:00 AM",
"available": "10"
}
],
"2": [],
"3": [],
"4": [],
"5": [],
"6": []
},
"block_dates": [],
"notification_settings": {
"new_reservation": {
"enabled": true,
"message": "Your reservation has been confirmed"
}
},
"custom_properties": {},
"channels": [
"WhatsApp",
"Sms"
],
"terms": "Please arrive 5 minutes before your scheduled time",
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
},
"message": "Calendar created successfully"
}
Show Calendar Details
Retrieves detailed information about a specific calendar, including any requested relationships.
Headers
URL Parameters
The ID of the calendar.
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- space
- reservations
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/calendars/1?include=space%2Creservations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"name": "Meeting Room A",
"slug": "meeting-room-a",
"description": "Large meeting room for up to 20 people",
"is_active": true,
"space_id": 1,
"visibility": "Public",
"min_capacity": 1,
"max_capacity": 20,
"is_required_approval": false,
"is_auto_approval": true,
"cancel_before_minutes": 60,
"book_before_minutes": 30,
"reminder_minutes": 15,
"crm_auto_import": true,
"is_unavailable_timeslots_visible": false,
"is_qr_code_visible": true,
"default_timeslots": {
"0": [],
"1": [
{
"id": "9b1f6c2e-4a5d-4e8b-9c3f-2d7a1e6b5c40",
"day": "monday",
"start_at": "09:00 AM",
"title": "Monday",
"timeslot": "09:00 AM - 10:00 AM",
"available": "10"
}
],
"2": [],
"3": [],
"4": [],
"5": [],
"6": []
},
"block_dates": [],
"notification_settings": {
"new_reservation": {
"enabled": true,
"message": "Your reservation has been confirmed"
}
},
"custom_properties": {},
"channels": [
"WhatsApp",
"Sms"
],
"terms": "Please arrive 5 minutes before your scheduled time",
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
}
}
Update Calendar
Updates an existing calendar's information.
All fields are optional.
Headers
URL Parameters
The ID of the calendar.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/calendars/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Meeting Room A\",
\"slug\": \"meeting-room-a\",
\"description\": \"Large meeting room for up to 20 people\",
\"space_id\": 1,
\"is_active\": true,
\"visibility\": \"Public\",
\"min_capacity\": 1,
\"max_capacity\": 20,
\"is_required_approval\": false,
\"is_auto_approval\": true,
\"cancel_before_minutes\": 60,
\"book_before_minutes\": 30,
\"is_max_advance_booking_enabled\": false,
\"max_advance_booking_days\": 30,
\"reminder_minutes\": 15,
\"crm_auto_import\": true,
\"is_unavailable_timeslots_visible\": false,
\"is_qr_code_visible\": true,
\"default_timeslots\": [
\"architecto\"
],
\"block_dates\": [
{
\"data\": {
\"start_date\": \"2025-07-01\",
\"end_date\": \"2025-07-07\",
\"timeslot_id\": [
\"architecto\"
]
}
}
],
\"notification_settings\": {
\"new_reservation\": {
\"enabled\": true,
\"message\": \"Your reservation has been confirmed.\"
}
},
\"custom_properties\": [],
\"channels\": [
\"WhatsApp\",
\"Sms\"
],
\"terms\": \"Please arrive 5 minutes before your scheduled time\"
}"
{
"data": {
"id": 1,
"name": "Meeting Room A",
"slug": "meeting-room-a",
"description": "Large meeting room for up to 20 people",
"is_active": true,
"space_id": 1,
"visibility": "Public",
"min_capacity": 1,
"max_capacity": 20,
"is_required_approval": false,
"is_auto_approval": true,
"cancel_before_minutes": 60,
"book_before_minutes": 30,
"reminder_minutes": 15,
"crm_auto_import": true,
"is_unavailable_timeslots_visible": false,
"is_qr_code_visible": true,
"default_timeslots": {
"0": [],
"1": [
{
"id": "9b1f6c2e-4a5d-4e8b-9c3f-2d7a1e6b5c40",
"day": "monday",
"start_at": "09:00 AM",
"title": "Monday",
"timeslot": "09:00 AM - 10:00 AM",
"available": "10"
}
],
"2": [],
"3": [],
"4": [],
"5": [],
"6": []
},
"block_dates": [],
"notification_settings": {
"new_reservation": {
"enabled": true,
"message": "Your reservation has been confirmed"
}
},
"custom_properties": {},
"channels": [
"WhatsApp",
"Sms"
],
"terms": "Please arrive 5 minutes before your scheduled time",
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z"
},
"message": "Calendar updated successfully"
}
Delete Calendar
Deletes a calendar from the system.
Only calendars without active reservations can be deleted.
Headers
URL Parameters
The ID of the calendar.
curl --request DELETE \
"https://explore.pixalink.io/api/calendars/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" [Empty response]
Reservations
List Reservations
Returns a paginated list of reservations belonging to the authenticated user's organisation.
Results can be filtered, sorted and include related data through query parameters.
Headers
Query Parameters
Comma-separated list of relationships to include:
- calendar
- customer
- calendar.space
Filter by calendar ID.
Filter by customer ID.
Filter by reservation status. Must be one of:
- pending
- rejected
- reserved
- cancelled
- no_show
Filter by reservation date. Use ISO 8601 format (YYYY-MM-DD).
Filter reservations from this date onwards (inclusive). Use ISO 8601 format (YYYY-MM-DD).
Filter reservations up to this date (inclusive). Use ISO 8601 format (YYYY-MM-DD).
Filter by customer name (partial match).
Filter by customer email (partial match).
Filter by customer phone number (partial match).
Sort field and direction. Allowed fields: date, start_at, created_at, status, name.
Number of records per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/reservations?include=calendar%2Ccustomer&filter%5Bcalendar_id%5D=1&filter%5Bcustomer_id%5D=1&filter%5Bstatus%5D=reserved&filter%5Bdate%5D=2024-01-01&filter%5Bdate_from%5D=2024-01-01&filter%5Bdate_to%5D=2024-01-31&filter%5Bname%5D=John&filter%5Bemail%5D=john%40example.com&filter%5Bphone_number%5D=%2B60123&sort=-date&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"ref_id": "RSV001234",
"date": "2024-03-15",
"start_at": "2024-03-15T14:30:00.000000Z",
"end_at": "2024-03-15T16:00:00.000000Z",
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"number_of_guests": 4,
"status": "reserved",
"remarks": "Birthday celebration",
"custom_fields": {
"dietary_requirements": "Vegetarian",
"special_requests": "Window seat preferred"
},
"timeslot_id": 5,
"calendar_id": 1,
"customer_id": 123,
"reminder_sent_at": "2024-03-14T14:30:00.000000Z",
"rejection_reason": null,
"created_at": "2024-03-01T10:15:30.000000Z",
"updated_at": "2024-03-10T16:22:45.000000Z",
"calendar": {
"id": 1,
"name": "Restaurant Reservations",
"slug": "restaurant-reservations",
"description": "Main dining room reservations",
"is_active": true,
"space_id": 1,
"visibility": "public",
"min_capacity": 1,
"max_capacity": 8,
"is_required_approval": true,
"is_auto_approval": false,
"cancel_before_minutes": 60,
"book_before_minutes": 30,
"reminder_minutes": 1440,
"crm_auto_import": true,
"is_unavailable_timeslots_visible": false,
"is_qr_code_visible": true,
"space": {
"id": 1,
"name": "Main Branch",
"slug": "main-branch",
"description": "Our flagship restaurant location"
}
},
"customer": {
"id": 123,
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"current_point": 2500,
"tier_id": 2
}
}
],
"links": {
"first": "{{$baseUrl}}/reservations?page=1",
"last": "{{$baseUrl}}/reservations?page=5",
"prev": null,
"next": "{{$baseUrl}}/reservations?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/reservations?page=1",
"label": "1",
"active": true
},
{
"url": "{{$baseUrl}}/reservations?page=2",
"label": "Next »",
"active": false
}
],
"path": "{{$baseUrl}}/reservations",
"per_page": 15,
"to": 15,
"total": 68
}
}
Create Reservation
Creates a new reservation in the system.
The reservation will be associated with a calendar and optionally with a customer.
Auto-generates a unique reference ID.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/reservations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date\": \"2024-03-15\",
\"start_at\": \"2024-03-15T14:30:00Z\",
\"end_at\": \"2024-03-15T16:00:00Z\",
\"name\": \"John Smith\",
\"email\": \"john.smith@example.com\",
\"phone_number\": \"+60123456789\",
\"number_of_guests\": 4,
\"status\": \"pending\",
\"remarks\": \"Birthday celebration, window seat preferred\",
\"custom_fields\": {
\"dietary_requirements\": \"Vegetarian\",
\"special_requests\": \"Birthday cake arrangement\"
},
\"timeslot_id\": 5,
\"calendar_id\": 1,
\"customer_id\": 123,
\"rejection_reason\": \"Fully booked on requested date\"
}"
{
"data": {
"id": 1,
"ref_id": "RSV001234",
"date": "2024-03-15",
"start_at": "2024-03-15T14:30:00.000000Z",
"end_at": "2024-03-15T16:00:00.000000Z",
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"number_of_guests": 4,
"status": "pending",
"remarks": "Birthday celebration",
"custom_fields": {
"dietary_requirements": "Vegetarian"
},
"timeslot_id": null,
"calendar_id": 1,
"customer_id": null,
"reminder_sent_at": null,
"rejection_reason": null,
"created_at": "2024-03-01T10:15:30.000000Z",
"updated_at": "2024-03-01T10:15:30.000000Z"
},
"message": "Reservation created successfully"
}
Show Reservation Details
Retrieves detailed information about a specific reservation, including any requested relationships.
Headers
URL Parameters
The ID of the reservation to show.
Query Parameters
Comma-separated list of relationships to include. Available relationships:
- calendar
- customer
- calendar.space
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/reservations/1?include=calendar%2Ccustomer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": {
"id": 1,
"ref_id": "RSV001234",
"date": "2024-03-15",
"start_at": "2024-03-15T14:30:00.000000Z",
"end_at": "2024-03-15T16:00:00.000000Z",
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"number_of_guests": 4,
"status": "reserved",
"remarks": "Birthday celebration",
"custom_fields": {
"dietary_requirements": "Vegetarian"
},
"timeslot_id": 5,
"calendar_id": 1,
"customer_id": 123,
"reminder_sent_at": "2024-03-14T14:30:00.000000Z",
"rejection_reason": null,
"created_at": "2024-03-01T10:15:30.000000Z",
"updated_at": "2024-03-10T16:22:45.000000Z",
"calendar": {
"id": 1,
"name": "Restaurant Reservations",
"space_id": 1
}
}
}
Update Reservation
Updates an existing reservation's information.
All fields are optional.
Status transitions are validated according to business rules.
Headers
URL Parameters
The ID of the reservation to update.
Body Parameters
Response Fields
curl --request PUT \
"https://explore.pixalink.io/api/reservations/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date\": \"2024-03-15\",
\"start_at\": \"2024-03-15T14:30:00Z\",
\"end_at\": \"2024-03-15T16:00:00Z\",
\"name\": \"John Smith\",
\"email\": \"john.smith@example.com\",
\"phone_number\": \"+60123456789\",
\"number_of_guests\": 4,
\"status\": \"pending\",
\"remarks\": \"Birthday celebration, window seat preferred\",
\"custom_fields\": {
\"dietary_requirements\": \"Vegetarian\",
\"special_requests\": \"Birthday cake arrangement\"
},
\"timeslot_id\": 5,
\"calendar_id\": 1,
\"customer_id\": 123,
\"rejection_reason\": \"Fully booked on requested date\"
}"
{
"data": {
"id": 1,
"ref_id": "RSV001234",
"date": "2024-03-15",
"start_at": "2024-03-15T14:30:00.000000Z",
"end_at": "2024-03-15T16:00:00.000000Z",
"name": "John Smith",
"email": "john.smith@example.com",
"phone_number": "+60123456789",
"number_of_guests": 6,
"status": "reserved",
"remarks": "Anniversary celebration - updated guest count",
"custom_fields": {
"dietary_requirements": "Vegetarian, Gluten-free"
},
"timeslot_id": 5,
"calendar_id": 1,
"customer_id": 123,
"reminder_sent_at": "2024-03-14T14:30:00.000000Z",
"rejection_reason": null,
"created_at": "2024-03-01T10:15:30.000000Z",
"updated_at": "2024-03-10T16:22:45.000000Z"
},
"message": "Reservation updated successfully"
}
Delete Reservation
Soft deletes a reservation from the system.
The reservation can be restored later if needed.
Headers
URL Parameters
The ID of the reservation to delete.
curl --request DELETE \
"https://explore.pixalink.io/api/reservations/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"message": "Reservation deleted successfully"
}
Endpoints
Get authenticated user
Retrieves the currently authenticated user's information.
Headers
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"id": 3,
"organisation_id": 2,
"name": "User",
"email": "vendor@pixalink.io",
"email_verified_at": "2025-01-31T21:16:49.000000Z",
"created_at": "2025-01-31T21:16:49.000000Z",
"updated_at": "2025-01-31T21:16:49.000000Z",
"deleted_at": null,
"is_service_account": false,
"outlet": null
}
Location Management
List all countries
Get a list of all countries with their details.
Headers
Query Parameters
Filter countries by name.
Filter countries by nationality.
Filter countries by ISO code.
Number of records to display per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/countries?filter%5Bname%5D=Malaysia&filter%5Bnationality%5D=Malaysian&filter%5Biso%5D=MY&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Malaysia",
"nationality": "Malaysian",
"iso": "MY",
"iso3": "MYS"
}
],
"links": {
"first": "{{$baseUrl}}/api/countries?page=1",
"last": "{{$baseUrl}}/api/countries?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/api/countries?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "{{$baseUrl}}/api/countries",
"per_page": 15,
"to": 1,
"total": 1
}
}
List all states
Get a list of all states with their associated countries.
Headers
Query Parameters
Filter states by name.
Filter states by country ID.
Include related models (Possible values: country).
Number of records to display per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/states?filter%5Bname%5D=Selangor&filter%5Bcountry_id%5D=1&include=country&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Selangor",
"country": {
"id": 1,
"name": "Malaysia",
"nationality": "Malaysian",
"iso": "MY",
"iso3": "MYS",
"phone_code": "60"
}
}
],
"links": {
"first": "{{$baseUrl}}/api/states?page=1",
"last": "{{$baseUrl}}/api/states?page=5",
"prev": null,
"next": "{{$baseUrl}}/api/states?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"path": "{{$baseUrl}}/api/states",
"per_page": 15,
"to": 15,
"total": 75
}
}
List all cities
Get a list of all cities with their associated states.
Headers
Query Parameters
Filter cities by name.
Filter cities by state ID.
Include related models (Possible values: state, state.country).
Sort by specified field. Prefix with - for descending sort. Possible values: name
Number of records to display per page.
Response Fields
curl --request GET \
--get "https://explore.pixalink.io/api/cities?filter%5Bname%5D=Petaling+Jaya&filter%5Bstate_id%5D=1&include=state%2Cstate.country&sort=-name&per_page=15" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" {
"data": [
{
"id": 1,
"name": "Petaling Jaya",
"state": {
"id": 1,
"name": "Selangor",
"country": {
"id": 1,
"name": "Malaysia",
"nationality": "Malaysian",
"iso": "MY",
"iso3": "MYS",
"phone_code": "60"
}
}
}
],
"links": {
"first": "{{$baseUrl}}/api/cities?page=1",
"last": "{{$baseUrl}}/api/cities?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{{$baseUrl}}/api/cities?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "{{$baseUrl}}/api/cities",
"per_page": 15,
"to": 1,
"total": 1
}
}
SSO
Generate a signed SSO login URL for a customer.
Verifies the HMAC-signed request, finds or creates the customer by phone number,
then returns a temporary signed URL that logs the customer into the loyalty portal.
The signed URL is valid for 10 minutes.
The URL uses the organisation's main outlet, carrying a requested secondary outlet
as a signed store slug for attribution. Without a main outlet, it uses the requested outlet.
Pass locale to land the customer in a specific language. A locale the organisation has
not enabled is dropped rather than rejected — the language a page renders in must never
take the login itself down — so compare the returned locale against what you sent to
detect a mis-configured integration. An accepted locale is covered by the URL signature.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/sso/redirect" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customer_phone\": \"+60123456789\",
\"space_id\": 42,
\"timestamp\": 1746518400,
\"redirect_to\": \"rewards\",
\"locale\": \"ms\"
}"
{
"redirect_url": "https://explore.pixalink.io/l/main-outlet/login/42?expires=1746518400&locale=ms&redirect_to=rewards&store=bangsar-outlet&signature=abc123...",
"locale": "ms"
}
Resolve an outbound SSO ticket.
Verifies the HMAC-signed request, then exchanges a single-use ticket for the customer identity it was minted against. The ticket is consumed on first use, so a second call with the same ticket returns 410. Only the organisation that owns the ticket may resolve it.
Headers
Body Parameters
Response Fields
curl --request POST \
"https://explore.pixalink.io/api/sso/resolve" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ticket\": \"kP3x…opaque…9Qz\",
\"timestamp\": 1746518400
}"
{
"customer": {
"id": 42,
"name": "Jane Doe",
"phone_number": "+60123456789",
"email": "jane@example.com",
"space_id": 1,
"organisation_id": 7
},
"context": {},
"locale": "ms"
}