Create Gift Card

Production

https://api.getroamify.com

POST

/api/gifts/gift

Last modified:2025-01-06 23:19:20

Maintainer:Not configured

To create a gift card, you need to send a POST request to the /api/gifts/gift endpoint.

The request body should contain the following parameters:

orderId: The order ID of for your own reference. This is a required field of type string.

senderEmail: The email address of the sender. This is a required field of type string.

sender: The name of the sender. This is an optional field of type string.

amount: The amount of the gift card. This is a required field of type number.

currency: The currency of the gift card. This is a required field of type string. The currency should be in ISO 4217 format.

Request

Header Params

Body Params application/json

Example

{
	"orderId": "test-order-id-101",
	"amount": 10,
	"currency": "USD",
	"senderEmail": "test@gmail.com",
	"sender": "optional"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.getroamify.com/api/gifts/gift' \
--header 'User-Agent: insomnia/10.1.0' \
--header 'Authorization: token' \
--header 'Content-Type: application/json' \
--data-raw '{
	"orderId": "test-order-id-101",
	"amount": 10,
	"currency": "USD",
	"senderEmail": "test@gmail.com",
	"sender": "optional"
}'

Responses

🟢200successfully / 200

text/plain

Body

Example

application/json; charset=utf-8 content type is not supported in the response body

Modified at 2025-01-06 23:19:20

Revoke Gift Card

Get all Gifts