Contents
On this page

Create Gift Card - Plugixa Car Wash

POST /plugixa-carwash/v1/gift-cards

Create a gift card.

Needs Plugixa Car Wash Pro with the Gift cards app on, and the plugixa_carwash_create capability.

Request

POST https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards

Request body

Content type: application/json

Field Type Required Description
initial_value number Yes 0.01 to 100000. The card opens with this balance.
code string No Anything but letters and digits is removed and the rest upper-cased; 6 to 40 characters must remain. Unique. Defaults to a random 12-character code without look-alike characters.
currency string No Three letters. Defaults to the site’s currency.
recipient_name string No At most 190 characters. Defaults to empty.
recipient_email string No A valid address when given. Defaults to empty.
purchaser_name string No At most 190 characters. Defaults to empty.
message string No At most 1000 characters. Defaults to empty.
expires_on string No Y-m-d. Anything else is stored as no date. Defaults to none.
status string No published or unpublished. Defaults to published.

A customer spends it by typing the code in the booking form’s code field. To change the balance by hand use Adjust Gift Card Balance.

{
  "initial_value": 50,
  "recipient_name": "Mia",
  "recipient_email": "mia@example.com",
  "purchaser_name": "Lucas",
  "message": "Happy birthday!",
  "expires_on": "2027-11-12"
}

Responses

201 Created. data is the new gift card.

{
  "success": true,
  "data": {
    "id": 11,
    "code": "K7PQ2DW3HN9C",
    "initial_value": 50.0,
    "balance": 35.5,
    "currency": "USD",
    "recipient_name": "Mia",
    "recipient_email": "mia@example.com",
    "purchaser_name": "Lucas",
    "message": "Happy birthday!",
    "expires_on": "2027-11-12",
    "status": "published",
    "created_by": 1,
    "modified_by": 1,
    "created_at": "2026-11-10 08:15:00",
    "modified_at": "2026-11-12 09:30:00",
    "deleted_at": null
  }
}
Field Type Meaning
data.id integer The gift card’s id
data.code string Upper-case letters and digits
data.initial_value number Its value when issued
data.balance number What is left on it
data.currency string It can only pay for bookings in this currency
data.expires_on string|null Last day it can be used, Y-m-d
data.created_at string UTC datetime
data.modified_at string UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
data.deleted_at string|null null unless the record is in the trash

Errors

Status Code When
422 plugixa_carwash_missing_initial_value initial_value is missing or empty.
422 plugixa_carwash_too_long_{field} A text field is too long. The code names the field.
422 plugixa_carwash_too_small_{field} / too_large_{field} A number is outside its range. The code names the field.
422 plugixa_carwash_invalid_{field} A choice field has a value that is not one of its choices. The code names the field.
422 plugixa_carwash_invalid_recipient_email recipient_email is not a valid address.
422 plugixa_carwash_invalid_gift_card The code is not 6 to 40 letters and digits.
409 plugixa_carwash_duplicate_code Another gift card already uses this code.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"initial_value":50,"recipient_name":"Mia","recipient_email":"mia@example.com","purchaser_name":"Lucas","message":"Happy birthday!","expires_on":"2027-11-12"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'initial_value'   => 50,
        'recipient_name'  => 'Mia',
        'recipient_email' => 'mia@example.com',
        'purchaser_name'  => 'Lucas',
        'message'         => 'Happy birthday!',
        'expires_on'      => '2027-11-12',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${auth}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    initial_value: 50,
    recipient_name: 'Mia',
    recipient_email: 'mia@example.com',
    purchaser_name: 'Lucas',
    message: 'Happy birthday!',
    expires_on: '2027-11-12',
  }),
});
const { data } = await response.json();

Quick Links

Share