Sign in

v1

latestOpenAPI 3.0.02026-07-267331140.7 KB
Physical Card Order

Create Physical Card Order

Orders a new physical card for the authenticated user. This is the first step in the physical card order process, the card is not created yet.

Next are the steps to complete the order:

  1. Optionally attach a coupon using /api/v1/order/{orderId}/attach-coupon (use the GPDOCS coupon code to get the card for free)
  2. If not free, attach a transaction hash using /api/v1/order/{orderId}/attach-transaction
  3. Confirm the payment using /api/v1/order/{orderId}/confirm-payment
  4. Create the card using /api/v1/order/{orderId}/create-card
post/api/v1/order/create

Request body

OR

Example request

{
  "shippingAddress": {
    "country": "BR"
  }
}

Response

Card order created successfully

idstring required
transactionHashstring
createdAtstring date-time required
status'PENDINGTRANSACTION' | 'TRANSACTIONCOMPLETE' | 'CONFIRMATIONREQUIRED' | 'READY' | 'CARDCREATED' | 'FAILEDTRANSACTION' | 'CANCELLED' required

Current order status in the state machine. See the state transition diagram in the documentation for valid transitions.

personalizationSource'KYC' | 'ENS' required
embossedNamestring
address1string
address2string
citystring
countrystring
postalCodestring
statestring
couponCodestring
totalAmountEURnumber double
totalDiscountEURnumber double required
virtualboolean

Example response

{
  "status": "PENDINGTRANSACTION"
}