Skip to main content
POST
Consolidategiftcards

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Headers

idempotency-key
string | null
X-Eposn-Customer-Token
string | null
X-Eposn-Merchant-Token
string | null

Path Parameters

programId
string | null
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

cardId
string | null
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
cardNumbers
string[]
required
Required array length: 2 - 10 elements
merchantId
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

customerEmail
string<email> | null
customerName
string | null
Maximum string length: 255
senderName
string | null
Maximum string length: 255
referenceId
string | null
Maximum string length: 100
description
string | null
Maximum string length: 500
isPhysical
boolean
default:false
designTemplate
string | null
Maximum string length: 100
customMessage
string | null
Maximum string length: 500

Response

Successful Response

success
boolean
required
message
string
required
newCard
GiftCardResponse · object
required
voidedCards
string[]
required
totalConsolidatedAmount
string
required
consolidationTransactions
string[]
required
referenceId
string | null
required