GET
/
gift-card-service-definitions
/
{gift_card_service_definition_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/gift-card-service-definitions/{gift_card_service_definition_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "qwikcilver-gift-card",
  "type": "gift-card-service-definition",
  "display_name": "Stripe",
  "fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "icon_url": "https://cdn.gr4vy.app/stripe.svg"
}

This endpoint requires the gift-card-service-definitions.read scope.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
gift_card_service_definition_id
string
required

The unique ID of the gift card service definition.

Example:

"qwikcilver-gift-card"

Response

200
application/json
Returns a gift card service definition.

An available gift card service that can be configured.

​
id
string

The ID of the gift card service definition.

Example:

"qwikcilver-gift-card"

​
type
enum<string>
default:gift-card-service-definition

gift-card-service-definition.

Available options:
gift-card-service-definition
Example:

"gift-card-service-definition"

​
display_name
string

The display name of this service.

Example:

"Stripe"

​
fields
object[]

A list of fields that need to be submitted when activating the payment. service.

A single field that needs to be submitted for a payment service when it is created.

​
icon_url
string

An icon to display for the payment service.

Example:

"https://cdn.gr4vy.app/stripe.svg"

Was this page helpful?

Delete anti-fraud serviceNew gift card service