Card Orders - Entries Create

Accessible By

multiplier, customer

Parameters:

Needs either voucher id or token to identify a card but can only use one, also one of them is required when renewing.

name	type	default	info
voucher_id	string	NONE	OPTIONAL
voucher_token	string	NONE	OPTIONAL
renew	boolean	NONE	OPTIONAL
replacement	boolean	NONE	OPTIONAL, REQUIRED if voucher_id or voucher_token
emboss_line_1	string	NONE	OPTIONAL, REQUIRED if voucher_id or voucher_token
emboss_line_2	string	NONE	OPTIONAL, REQUIRED if voucher_id or voucher_token
image_id	string	NONE	OPTIONAL, REQUIRED if NOT voucher_id or voucher_token
voucher_owner_id	string	NONE	OPTIONAL
voucher_owner	voucher owner object	NONE	OPTIONAL
voucher_configuration	voucher configuration object	NONE	OPTIONAL

Voucher Owner

Voucher owner can't be used if you are already using a voucher id.

name	type	default	info
title	string	NONE	OPTIONAL
first_name	string	NONE	OPTIONAL
last_name	string	NONE	OPTIONAL
identifier	string	NONE	OPTIONAL
email	string	NONE	OPTIONAL
address_line_1	string	NONE	OPTIONAL
address_line_2	string	NONE	OPTIONAL
zip_code	string	NONE	OPTIONAL
city	string	NONE	OPTIONAL
country_code	string	NONE	OPTIONAL

Voucher Configuration

name	type	default	info
type	string	NONE	REQUIRED, can be classic, regional, national or lunch
postal_data_id	string	NONE	REQUIRED if regional

curl --location --request POST 'https://www-staging.givve.com/api/card_orders//entries' \ --header 'Authorization: Bearer ' \ --header 'Accept-Version: v2' \ --header 'Content-Type: application/json' \ --data-raw '{ "voucher_id": "string", "voucher_id": "string", "renew": true, "replacement": false, "emboss_line_1": "string", "emboss_line_2": "string", "image_id": "string", "voucher_owner_id": "string", "voucher_owner": { "title": "string", "first_name": "string", "last_name": "string", "identifier": "string", "email": "string", "address_line_1": "string", "address_line_2": "string", "zip_code": "string", "city": "string", "country_code": "string" }, "voucher_configuration": { "type": "string", "postal_data_id": "string" } }'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

card_order_id

string

required

Header Params

Authorization

string

required

Example:

Bearer {{token}}

Accept-Version

string

required

Example:

Body Params application/json

voucher_id

string

optional

renew

boolean

optional

replacement

boolean

optional

emboss_line_1

string

optional

emboss_line_2

string

optional

image_id

string

optional

voucher_owner_id

string

optional

voucher_owner

object

optional

title

string

optional

first_name

string

optional

last_name

string

optional

identifier

string

optional

string

optional

address_line_1

string

optional

address_line_2

string

optional

zip_code

string

optional

city

string

optional

country_code

string

optional

voucher_configuration

object

optional

type

string

optional

postal_data_id

string

required

Examples

Create

Card Orders - Entries Create#

Accessible By#

Parameters:#

Voucher Owner#

Voucher Configuration#

Request

Responses

Card Orders - Entries Create

Accessible By

Parameters:

Voucher Owner

Voucher Configuration