GNgnosispay
Physical Card Order

Retrieve details of a Physical Card Order

This endpoint retrieves details of a card order by its orderId.

get/api/v1/order/{orderId}

Request

Path parameters

orderIdstring required

The unique identifier of the card order.

Response

Successfully retrieved card order details.

idstring uuid required

The unique identifier of the card order.

transactionHashstring nullable

The on-chain transaction hash associated with the order.

embossedNamestring nullable

The name embossed on the card.

address1string nullable

The first line of the shipping address.

address2string nullable

The second line of the shipping address.

citystring nullable

The city of the shipping address.

postalCodestring nullable

The postal code of the shipping address.

statestring nullable

The state of the shipping address.

countrystring nullable

The country of the shipping address.

userIdstring required

The user id for this card order.

status'PENDINGTRANSACTION' | 'TRANSACTIONCOMPLETE' | 'CONFIRMATIONREQUIRED' | 'READY' | 'CARDCREATED' | 'FAILEDTRANSACTION' | 'CANCELLED' required

Current order status

personalizationSource'KYC' | 'ENS' required
couponCodestring

The coupon code tied to this card order

totalAmountEURnumber nullable
totalDiscountEurnumber
createdAtstring date-time required

When the order was created

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "transactionHash": "0x123abc...",
  "embossedName": "John Doe",
  "couponCode": "DISCOUNT2023",
  "totalAmountEUR": 20.99,
  "totalDiscountEur": 1.99,
  "createdAt": "2023-01-09T13:45:30Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.