Gift cards
Get gift card
Payments
- Transactions
- Buyers
- Checkout Sessions
- Payment links
- Payment options
- Payouts
- Refunds
- Sessions
- Settlement records
Instruments
- Card schemes
- Card details
- Digital wallets
- Gift cards
- Payment methods
- Payment method definitions
Vault
- Account updater
- Network tokens
- Payment service tokens
- Vault Forward
- Vault Forward endpoints
- Vault Forward authentication
Connections
- All services
- Payment services
- Digital wallets
- Anti-fraud services
- Gift-card services
Other
- Flow
- Merchant accounts
- Reports
- Report executions
- Webhook subscriptions
Gift cards
Get gift card
Retrieves details of a stored gift card.
GET
/
gift-cards
/
{gift_card_id}
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/gift-cards/{gift_card_id} \
--header 'Authorization: Bearer <token>'
{
"type": "gift-card",
"id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
"merchant_account_id": "default",
"service": {
"type": "gift-card-service",
"id": "6c020bf3-179b-4f4f-858d-84e39e196e0f",
"merchant_account_id": "default",
"gift_card_service_definition_id": "qwikcilver-gift-card",
"display_name": "Qwikcilver UK",
"active": true,
"fields": [
{
"key": "secret_key",
"value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
}
],
"created_at": "2012-12-12T10:53:43+00:00",
"updated_at": "2012-12-12T10:53:43+00:00"
},
"bin": "412345",
"sub_bin": "554",
"last4": "1234",
"expiration_date": "2013-07-16T19:23:00.000+00:00",
"buyer": {
"type": "buyer",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"billing_details": {
"type": "billing-details",
"first_name": "John",
"last_name": "Lunn",
"email_address": "john@example.com",
"phone_number": "+1234567890",
"address": {
"city": "London",
"country": "GB",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy"
},
"tax_id": {
"value": "12345678931",
"kind": "gb.vat"
}
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"display_name": "John L.",
"external_identifier": "user-789123",
"merchant_account_id": "default",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"account_number": "1234567"
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
This endpoint requires the gift-cards.read
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID of a stored gift card.
Example:
"e6cdf979-87e2-4796-8ff6-9784d5aed893"
Response
200
application/json
Returns a stored gift card.
A gift card stored for a buyer, or used in a transaction.
Was this page helpful?
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/gift-cards/{gift_card_id} \
--header 'Authorization: Bearer <token>'
{
"type": "gift-card",
"id": "e6cdf979-87e2-4796-8ff6-9784d5aed893",
"merchant_account_id": "default",
"service": {
"type": "gift-card-service",
"id": "6c020bf3-179b-4f4f-858d-84e39e196e0f",
"merchant_account_id": "default",
"gift_card_service_definition_id": "qwikcilver-gift-card",
"display_name": "Qwikcilver UK",
"active": true,
"fields": [
{
"key": "secret_key",
"value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
}
],
"created_at": "2012-12-12T10:53:43+00:00",
"updated_at": "2012-12-12T10:53:43+00:00"
},
"bin": "412345",
"sub_bin": "554",
"last4": "1234",
"expiration_date": "2013-07-16T19:23:00.000+00:00",
"buyer": {
"type": "buyer",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"billing_details": {
"type": "billing-details",
"first_name": "John",
"last_name": "Lunn",
"email_address": "john@example.com",
"phone_number": "+1234567890",
"address": {
"city": "London",
"country": "GB",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy"
},
"tax_id": {
"value": "12345678931",
"kind": "gb.vat"
}
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"display_name": "John L.",
"external_identifier": "user-789123",
"merchant_account_id": "default",
"updated_at": "2013-07-16T19:23:00.000+00:00",
"account_number": "1234567"
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}