POST
/
gift-card-services

This endpoint requires the gift-card-services.write scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for activating a gift card service.

gift_card_service_definition_id
string
required

The ID of the gift card service to use.

Required string length: 1 - 50
display_name
string
required

A custom name for the service. This will be shown in the Admin UI.

Required string length: 1 - 50
fields
object[]
required

A list of fields, each containing a key-value pair for each field defined by the definition for this gift card service.

active
boolean
default: true

Defines if this service is currently active or not.

Response

201 - application/json

An configured gift card service.

type
enum<string>

The type of this resource.

Available options:
gift-card-service
id
string

The ID of this gift card service.

merchant_account_id
string

The unique ID for a merchant account.

gift_card_service_definition_id
string

The ID of the gift card service definition used to create this service.

Required string length: 1 - 50
display_name
string

The custom name set for this service.

Required string length: 1 - 200
active
boolean

Defines if this service is currently active or not.

fields
object[]

A list of fields, each containing a key-value pair for each field configured for this gift card service. Fields marked as secret are not returned.

created_at
string

The date and time when this service was created.

updated_at
string

The date and time when this service was last updated.

Was this page helpful?

Get service definitionGet gift card service