Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Cards

Create Card Image

Create a card image entity. Note that this does not include the image data itself. You can upload the image data via a subsequent uploadCardImageData request using the ID created here.

post/cards/images

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

card_product_idstring uuid required

The unique identifier of a cards product

customer_idstring uuid required

The unique identifier of a customer

Example request

{
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Response

Card image entity created

card_product_idstring uuid required

The unique identifier of a cards product

customer_idstring uuid required

The unique identifier of a customer

idstring uuid required

The unique identifier of a card image

rejection_memostring
rejection_reason'BRANDED' | 'COPYRIGHT' | 'INAPPROPRIATE' | 'OTHER' | 'PROMOTIONAL' | 'TRADEMARK'

The category of reason that a card image was rejected

status'APPROVED' | 'NOT_UPLOADED' | 'REJECTED' | 'UNREVIEWED' required

The status of a custom card image

Example response

{
  "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}