ReDoc documentation

giftcardaccounts/{id}

giftcardaccounts/{id}

Retrieve a gift card account by ID.

Request
path Parameters
id
required
integer
Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

get/V1/giftcardaccounts/{id}
Response samples
{
  • "account_id": 0,
  • "code": "string",
  • "status": 0,
  • "date_created": "string",
  • "date_expires": "string",
  • "balance": 0,
  • "state": 0,
  • "is_redeemable": 0
}

giftcardaccounts/{id}

Update an existing gift card account (merge semantics — only non-null fields are applied). Code is immutable; passing a different code throws InputException.

Request
path Parameters
id
required
integer
Request Body schema:
required
object (gift-card-account-api-data-gift-card-account-data-interface)

Data interface for individual gift card account entities.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

put/V1/giftcardaccounts/{id}
Request samples
{
  • "giftcardAccount": {
    }
}
Response samples
{
  • "account_id": 0,
  • "code": "string",
  • "status": 0,
  • "date_created": "string",
  • "date_expires": "string",
  • "balance": 0,
  • "state": 0,
  • "is_redeemable": 0
}

giftcardaccounts/{id}

Delete a gift card account by ID.

Request
path Parameters
id
required
integer
Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

delete/V1/giftcardaccounts/{id}
Response samples
true
➔ Next to hierarchy/move/{id}