> ## Documentation Index
> Fetch the complete documentation index at: https://catchbackcards.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a one-token shipment

> Creates and opens a payment for shipping one token, with the token in the path. Answers with the shipment as `quote` (no `shipment_id`, no `tokens`: the token's own `quote_id` names the shipment). It shares its `Idempotency-Key` space with Create a shipment. A token that already has a paid shipment waiting for its burn is refused with `TOKEN_IN_SHIPMENT` and that shipment's `quote_id`.



## OpenAPI

````yaml /partner-api/v2/openapi.yaml post /api/partner/v2/tokens/{tokenId}/shipment
openapi: 3.1.0
info:
  title: CatchBack Partner API v2 (wallets & NFTs)
  version: 2.0.0
  summary: >-
    Sell CatchBack packs to your users' own web3 wallets, and let the NFT holder
    sell back or ship.
  description: >-
    The official contract for Partner API v2. Generate clients from this file.


    Each customer pays for their own pack (USDC on Base or Solana, through a
    Unifold Payment

    Intent), and each pulled item is minted as an NFT to the customer's wallet.
    Whoever holds the

    NFT can trade it, sell it back for USDC, or have the physical item shipped.
    Selling back and

    shipping both burn the NFT. Guides: [Overview](/partner-api/v2/overview).


    - **Auth:** every `/api/partner/v2` request sends your key as a bearer
    token, and every key
      needs the scope `nft:orders`. The public token metadata needs no key.
    - **Your program:** your key is linked to your partner program, which fixes
    the chain your
      NFTs mint on (`mint_chain`) and your collection contract. An order, token, quote or shipment
      from another program answers `404`.
    - **Formats:** JSON, UTF-8. Money is USD as a number in dollars (`25`,
    `9.85`). New fields can be
      added to any response; ignore fields you don't know.
    - **Errors:** bodies are `{ "error": "<message>" }`, and errors your
    integration should act on
      also carry a stable `code` (see `ErrorCode`). Branch on the status and the `code`, never on the
      message text. [Errors](/partner-api/v2/errors).
    - **Idempotency:** `POST /orders`, `POST /shipments`, `POST
    /tokens/{tokenId}/shipment` and
      `POST /keys/rotate` require an `Idempotency-Key`. [Idempotency](/partner-api/v2/idempotency).
    - **Sandbox:** the sandbox runs the same API with simulated payments on a
    public testnet. Its base
      URL is issued on request, with a sandbox key. The operations tagged `Sandbox` exist only there
      and answer `404` in production.
  contact:
    name: CatchBack support
    email: support@catchbackcards.com
servers:
  - url: https://catchbackcards.com
    description: >-
      Production. Every payment is real money. The sandbox base URL is issued on
      request.
security:
  - bearerAuth:
      - nft:orders
tags:
  - name: Packs
    description: The packs you can sell, their odds and every item they can pull.
  - name: Orders
    description: >-
      Buy 1-10 packs for one wallet, follow the order to the mint, and prove the
      pull.
  - name: Tokens
    description: A wallet's tokens and one token's item, holder and sell-back schedule.
  - name: Sell-back
    description: >-
      Quote a sell-back, have the holder burn with it, and follow the USDC
      payout.
  - name: Shipments
    description: >-
      Pay shipping for 1-25 tokens, have the holder burn each one, and track the
      box.
  - name: Webhooks
    description: Register, read, test and remove your webhook URL.
  - name: Webhook events
    description: Signed POSTs we send to your webhook URL.
  - name: Keys
    description: Read, rotate and revoke your API key.
  - name: Revenue
    description: Your monthly revenue-share statement.
  - name: Sandbox
    description: Sandbox-only helpers. Every one answers `404` in production.
  - name: Metadata
    description: Public NFT metadata that wallets and marketplaces read with no key.
paths:
  /api/partner/v2/tokens/{tokenId}/shipment:
    post:
      tags:
        - Shipments
      summary: Create a one-token shipment
      description: >-
        Creates and opens a payment for shipping one token, with the token in
        the path. Answers with the shipment as `quote` (no `shipment_id`, no
        `tokens`: the token's own `quote_id` names the shipment). It shares its
        `Idempotency-Key` space with Create a shipment. A token that already has
        a paid shipment waiting for its burn is refused with `TOKEN_IN_SHIPMENT`
        and that shipment's `quote_id`.
      operationId: createTokenShipment
      parameters:
        - $ref: '#/components/parameters/TokenId'
        - $ref: '#/components/parameters/ShipmentIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTokenShipmentRequest'
            example:
              holder: 0x8f3c...e21a
              address:
                name: Alice Tester
                address1: 1 Market St
                city: San Francisco
                state: CA
                zip: '94105'
                country: US
                phone: '4155550100'
              rate:
                carrier: USPS
                token: usps_priority
              max_cost: 9.85
      responses:
        '200':
          description: >-
            A replay of an earlier request with the same `Idempotency-Key`
            (`idempotent_replay` is true).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTokenShipmentResponse'
        '201':
          description: The shipment and how to pay for it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTokenShipmentResponse'
              example:
                quote:
                  quote_id: 0xa93f...0c2d
                  status: awaiting_payment
                  shipping_cost: 9.85
                  holder: 0x8f3c...e21a
                  expires_at: '2026-11-17T18:40:00.000Z'
                  paid_at: null
                  burn: null
                payment:
                  intent_id: pi_01JE...
                  client_secret: pi_01JE..._secret_...
                  publishable_key: pk_live_...
                  amount: 9.85
                  deposit_addresses:
                    - chain: evm:8453
                      address: 0x5a4d...0002
                    - chain: solana:mainnet
                      address: 7kPq...Rt4w
        '400':
          $ref: '#/components/responses/ShipmentCreateBadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ShipmentCreateForbidden'
        '404':
          $ref: '#/components/responses/UnknownTokens'
        '409':
          $ref: '#/components/responses/ShipmentCreateConflict'
        '422':
          $ref: '#/components/responses/ShipmentKeyReused'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ChainOrScreeningUnavailable'
components:
  parameters:
    TokenId:
      name: tokenId
      in: path
      required: true
      description: >-
        The token's decimal `token_id`, on either chain family. Keep it as a
        string or bigint, never a JS number.
      schema:
        type: string
        pattern: ^[0-9]{1,78}$
      example: '81264573985362058461377125337283195667'
    ShipmentIdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Your own shipment id, 8-128 characters of `A-Za-z0-9_-`. Both shipment
        endpoints share one key space. The same key with a different request
        (tokens in any order, `holder`, `address`, `rate`, `cover_amount`) is
        `422`.
      schema:
        type: string
        pattern: ^[A-Za-z0-9_-]{8,128}$
      example: okx-ship-1c9e04
  schemas:
    CreateTokenShipmentRequest:
      $ref: '#/components/schemas/TokenShipmentCreateFields'
    CreateTokenShipmentResponse:
      type: object
      required:
        - quote
        - payment
      properties:
        quote:
          $ref: '#/components/schemas/TokenShipment'
        payment:
          oneOf:
            - $ref: '#/components/schemas/Payment'
            - type: 'null'
        idempotent_replay:
          type: boolean
          const: true
    TokenShipmentCreateFields:
      type: object
      required:
        - holder
        - address
        - rate
        - max_cost
      properties:
        holder:
          type: string
        address:
          $ref: '#/components/schemas/ShipmentAddress'
        rate:
          type: object
          required:
            - carrier
            - token
          description: A rate from the estimate. We re-quote it.
          properties:
            carrier:
              type: string
            token:
              type: string
        max_cost:
          type: number
          exclusiveMinimum: 0
          description: >-
            The most the holder will pay for shipping, in dollars (the
            estimate's `total`).
        cover_amount:
          $ref: '#/components/schemas/CoverAmount'
    TokenShipment:
      type: object
      description: >-
        A one-token shipment, named by the token's `quote_id`. `fulfilment` is
        present on reads and webhook events, not on the create response.
      required:
        - quote_id
        - status
        - shipping_cost
        - holder
        - expires_at
        - paid_at
        - burn
      properties:
        quote_id:
          type: string
        status:
          type: string
          enum:
            - awaiting_payment
            - ready
            - expired
            - redeemed
          description: >-
            `awaiting_payment`, `ready` (paid; burn it), `expired` (the paid
            burn window lapsed: renew it), `redeemed` (the burn was seen).
        shipping_cost:
          type:
            - number
            - 'null'
        holder:
          type: string
        expires_at:
          type: string
          format: date-time
          description: >-
            The end of the burn window once paid. An unpaid shipment never
            expires.
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
        burn:
          $ref: '#/components/schemas/ShipmentBurn'
        fulfilment:
          oneOf:
            - $ref: '#/components/schemas/Fulfilment'
            - type: 'null'
    Payment:
      type: object
      description: >-
        A Unifold Payment Intent for exactly the amount due. Open it in your app
        with `client_secret` and `publishable_key` (Unifold's web or React
        Native SDK), or show `deposit_addresses` and `amount`. Paid once at
        least 99% has arrived. [Payments](/partner-api/v2/payments).
      required:
        - intent_id
        - client_secret
        - publishable_key
        - amount
        - deposit_addresses
      properties:
        intent_id:
          type:
            - string
            - 'null'
          description: The Payment Intent's id (`sbx_pi_…` in the sandbox).
        client_secret:
          type:
            - string
            - 'null'
          description: Opens Unifold's checkout. Null once there is nothing left to pay.
        publishable_key:
          type:
            - string
            - 'null'
          description: The public Unifold key to initialise the SDK with.
        amount:
          type: number
          description: The amount due in USD (a multi-pack order's total).
        deposit_addresses:
          type: array
          description: >-
            Addresses the customer can send to directly, on Base and Solana.
            Empty once there is nothing left to pay. Never reuse one for another
            order.
          items:
            type: object
            required:
              - chain
              - address
            properties:
              chain:
                $ref: '#/components/schemas/ChainKey'
              address:
                type: string
    Error:
      type: object
      required:
        - error
      description: >-
        Every error body. `code` is stable where you might branch on it; some
        errors add the fields below.
      properties:
        error:
          type: string
          description: >-
            For people. The text can change, so branch on the status and the
            `code`.
        code:
          description: >-
            Machine-readable, where you might branch on it. New codes can be
            added, so treat an unknown one like a missing one.
          anyOf:
            - $ref: '#/components/schemas/ErrorCode'
            - type: string
        retry_after_seconds:
          type: integer
          description: On `RATE_LIMITED`.
        odds:
          description: >-
            On `BAD_ODDS` when the pack sells other odds: the choices it sells.
            On `ODDS_UNAVAILABLE` from Create an order: the choice asked for.
          oneOf:
            - type: array
              items:
                $ref: '#/components/schemas/Odds'
            - $ref: '#/components/schemas/Odds'
        reason:
          type:
            - string
            - 'null'
          description: On `PACK_UNAVAILABLE`, why the pack can't open.
        status:
          type: string
          description: On `NOT_PULLED`, the order's status.
        token_ids:
          type: array
          items:
            type: string
          description: On a refusal about particular tokens, the token ids it is about.
        quote_id:
          type: string
          description: >-
            On `TOKEN_IN_SHIPMENT` from the one-token endpoint, the shipment
            waiting for the burn.
        fields:
          type: object
          additionalProperties:
            type: string
          description: >-
            On `BAD_ADDRESS` from a shipment or estimate, each bad address field
            and what is wrong with it.
        order_value:
          type: number
          description: On `COVER_NOT_ALLOWED`.
        min_cover:
          type: number
          description: On `COVER_NOT_ALLOWED`.
        max_cover:
          type:
            - number
            - 'null'
          description: On `COVER_NOT_ALLOWED`; null when the items can't be insured.
        amount:
          type: number
          description: On `PRICE_CHANGED`, the current shipping cost.
        successor:
          type: object
          description: On `ALREADY_ROTATED`, the key that replaced this one.
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: On `ALREADY_ROTATED`, when this key stops working.
    ShipmentAddress:
      type: object
      required:
        - name
        - address1
        - city
        - country
      properties:
        name:
          type: string
          maxLength: 100
        address1:
          type: string
          maxLength: 100
        address2:
          type:
            - string
            - 'null'
          maxLength: 100
        city:
          type: string
          maxLength: 100
        state:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Where the country uses it.
        zip:
          type:
            - string
            - 'null'
          maxLength: 20
          description: Where the country uses it.
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO 3166 alpha-2.
        phone:
          type:
            - string
            - 'null'
          maxLength: 20
          description: Required outside the US.
    CoverAmount:
      type:
        - number
        - 'null'
      exclusiveMinimum: 0
      description: >-
        Shipping insurance cover in dollars, with at most two decimals, within
        the range the items allow (a `400` `COVER_NOT_ALLOWED` gives the range).
        Leave it out or null for none.
    ShipmentBurn:
      description: >-
        What the holder burns the token with, once the shipping is paid and
        while the window is open; else null.
      oneOf:
        - $ref: '#/components/schemas/EvmShipmentBurn'
        - $ref: '#/components/schemas/SolanaShipmentBurn'
        - type: 'null'
    Fulfilment:
      type: object
      description: >-
        Where the box is, once every burn is seen. Never the address or the
        label.
      required:
        - status
        - carrier
        - service
        - tracking_number
        - tracking_url
        - shipped_at
        - expected_delivery
        - delivered_at
        - created_at
      properties:
        status:
          type: string
          enum:
            - pending
            - processing
            - shipped
            - delivered
            - cancelled
            - needs_review
          description: >-
            `pending`: burns seen, the shipping order is being created.
            `processing`: being packed. `shipped`: on its way, with tracking.
            `delivered`. `cancelled`: by our team (rare); contact us.
            `needs_review`: we couldn't create the shipment; our team resolves
            it.
        carrier:
          type:
            - string
            - 'null'
        service:
          type:
            - string
            - 'null'
        tracking_number:
          type:
            - string
            - 'null'
        tracking_url:
          type:
            - string
            - 'null'
          description: The carrier's own tracking page.
        shipped_at:
          type:
            - string
            - 'null'
          format: date-time
        expected_delivery:
          type:
            - string
            - 'null'
          format: date
          description: A date, not a moment.
        delivered_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ChainKey:
      type: string
      description: >-
        A chain as `<family>:<id>`: `evm:8453` is Base, `evm:<chainId>` any
        other EVM chain (e.g. `evm:196`, X Layer), `solana:mainnet` Solana. The
        sandbox uses a public testnet.
      pattern: ^(evm:[0-9]+|solana:(mainnet|devnet))$
      examples:
        - evm:196
    ErrorCode:
      type: string
      description: Every `code` v2 returns. Branch on these, never on the message text.
      enum:
        - RATE_LIMITED
        - AUTH_UNAVAILABLE
        - NO_PROGRAM
        - PROGRAM_INACTIVE
        - NOT_AVAILABLE
        - BAD_JSON
        - BAD_IDEMPOTENCY_KEY
        - IDEMPOTENCY_KEY_REUSED
        - BAD_RECIPIENT
        - BAD_PACK
        - BAD_CATEGORY
        - BAD_ODDS
        - BAD_QUANTITY
        - ODDS_UNAVAILABLE
        - BAD_REFUND_ADDRESS
        - PACK_NOT_OFFERED
        - PACK_UNAVAILABLE
        - WALLET_REFUSED
        - WALLET_BLOCKED
        - SCREENING_UNAVAILABLE
        - UNKNOWN_ORDER
        - NOT_PULLED
        - VERIFY_UNAVAILABLE
        - BAD_CURSOR
        - BAD_LIMIT
        - BAD_STATUS
        - BAD_ADDRESS
        - BAD_PARTNER_USER_REF
        - TOO_MANY_WALLETS
        - UNKNOWN_TOKEN
        - BAD_HOLDER
        - NOT_HOLDER
        - CHAIN_UNAVAILABLE
        - TOKEN_NOT_MINTED
        - TOKEN_BURNED
        - TOKEN_NOT_LIVE
        - NO_OFFER
        - PAYOUT_CHAIN_NOT_SUPPORTED
        - PAYOUT_CHAIN_NOT_ENABLED
        - BAD_PAYOUT_ADDRESS
        - USE_SHIPMENT_ENDPOINT
        - BAD_TOKEN_IDS
        - TOKEN_IN_SHIPMENT
        - BAD_COVER
        - COVER_NOT_ALLOWED
        - COVER_UNAVAILABLE
        - BAD_MAX_COST
        - NOT_SHIPPABLE
        - PARTNER_GOODS
        - COUNTRY_NOT_SUPPORTED
        - OVER_CUSTOMS_CAP
        - RATE_UNAVAILABLE
        - PRICE_CHANGED
        - UNKNOWN_SHIPMENT
        - NOT_PAID
        - ALREADY_REDEEMED
        - HOLDER_CHANGED
        - UNKNOWN_QUOTE
        - INVALID_WEBHOOK_URL
        - WEBHOOK_ACCOUNT_CHANGED
        - WEBHOOKS_UNAVAILABLE
        - UNKNOWN_WEBHOOK
        - KEY_ROTATED
        - BAD_PERIOD
        - INVALID_KEY
        - NO_PREVIOUS_KEY
        - ALREADY_ROTATED
        - UNKNOWN_PAYMENT
        - NOT_BURNED
    Odds:
      type: string
      enum:
        - standard
        - hot
        - chill
        - classic
      description: >-
        The odds a pack is opened at, as in our app's picker. Standard, Hot and
        Chill share one value-band ladder and differ only in the chance of each
        band; Classic is the pack's own bands and chances. A pack that sells
        only its own odds sells just `classic`. [Odds](/partner-api/v2/odds).
    EvmShipmentBurn:
      type: object
      required:
        - quote
        - signature
      properties:
        quote:
          $ref: '#/components/schemas/EvmBurnQuote'
        signature:
          type: string
    SolanaShipmentBurn:
      type: object
      required:
        - transaction
        - vault
        - last_valid_block_height
      properties:
        transaction:
          type: string
          description: Base64 unsigned transaction, built fresh on every GET.
        vault:
          type: string
        last_valid_block_height:
          type: integer
    EvmBurnQuote:
      type: object
      description: >-
        The EIP-712 `Quote` struct to pass to `burnWithQuote` exactly as
        returned. Domain: name `CatchBackCards`, version `1`, your mint chain
        id, your contract. `kind` 1 is a sell-back, 2 a shipment. `tokenId`,
        `amount` (USDC, 6 decimals; "0" for a shipment) and `expiresAt` (unix
        seconds) are decimal strings: convert them to bigints.
      required:
        - tokenId
        - kind
        - quoteId
        - holder
        - payoutHash
        - amount
        - expiresAt
      properties:
        tokenId:
          type: string
        kind:
          type: integer
          enum:
            - 1
            - 2
        quoteId:
          type: string
          description: bytes32.
        holder:
          type: string
        payoutHash:
          type: string
          description: >-
            bytes32. Sell-back: keccak256(abi.encode(string payout.chain, string
            payout.address)). Shipment: keccak256(abi.encode(string "shipment",
            string quote_id)).
        amount:
          type: string
        expiresAt:
          type: string
  responses:
    ShipmentCreateBadRequest:
      description: >-
        - `BAD_IDEMPOTENCY_KEY`: `Idempotency-Key` missing, or not 8-128
        characters of `A-Za-z0-9_-`.

        - `BAD_JSON`: the body isn't JSON.

        - `BAD_TOKEN_IDS`: `token_ids` isn't a list of 1-25 distinct decimal
        token id strings (Create a shipment only).

        - `BAD_HOLDER`: `holder` is not a wallet address on your mint chain.

        - `BAD_ADDRESS`: the shipping address is invalid; `fields` maps each bad
        field to a message.

        - `BAD_COVER`: `cover_amount` isn't a positive dollar amount with at
        most two decimals.

        - `COVER_NOT_ALLOWED`: `cover_amount` is outside what the items can be
        insured for; the body has `order_value`, `min_cover` and `max_cover`.

        - `BAD_MAX_COST`: `max_cost` missing or not positive.

        - `NOT_SHIPPABLE`, `PARTNER_GOODS`, `COUNTRY_NOT_SUPPORTED`,
        `OVER_CUSTOMS_CAP`: as on the estimate.


        A refusal about particular tokens lists them in `token_ids`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              max_cost (the most the holder will pay for shipping, in dollars)
              is required
            code: BAD_MAX_COST
    Unauthorized:
      description: >-
        - `Missing or malformed API key`: no `Bearer cb_live_…` header.

        - `Invalid API key`: unknown or disabled, or a rotated key past its 24
        hours.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Missing or malformed API key
    ShipmentCreateForbidden:
      description: >-
        - `NOT_HOLDER`: that wallet does not hold the token(s) on chain right
        now (`token_ids` on Create a shipment).

        - `WALLET_REFUSED`: the holder failed sanctions screening.

        - Any of the key and program refusals every endpoint can return.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This wallet cannot redeem right now.
            code: WALLET_REFUSED
    UnknownTokens:
      description: >-
        `UNKNOWN_TOKEN`: no such token on your program's contract. On Create a
        shipment and Estimate a shipment, `token_ids` lists the unknown ones.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unknown token
            code: UNKNOWN_TOKEN
            token_ids:
              - '90311820476190023716442901288201455'
    ShipmentCreateConflict:
      description: >-
        - `TOKEN_NOT_LIVE`: a token isn't minted yet, or was already burned
        (`token_ids` lists them on Create a shipment).

        - `TOKEN_IN_SHIPMENT`: a token already has a paid shipment waiting for
        its burn; `token_ids` lists them (and `quote_id` on the one-token
        endpoint). Burn or renew that shipment instead.

        - `RATE_UNAVAILABLE`: the carrier no longer offers that rate; estimate
        again.

        - `COVER_UNAVAILABLE`: the chosen service has no cover option; choose
        another rate or leave `cover_amount` out.

        - `PRICE_CHANGED`: the shipping cost is now above `max_cost`; the body
        has the current `amount`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The shipping cost is now above max_cost.
            code: PRICE_CHANGED
            amount: 10.4
    ShipmentKeyReused:
      description: >-
        `IDEMPOTENCY_KEY_REUSED`: the key was already used for a different
        shipment.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This Idempotency-Key was already used for a different shipment.
            code: IDEMPOTENCY_KEY_REUSED
    RateLimited:
      description: >-
        `RATE_LIMITED`: too many requests from this key. Wait
        `retry_after_seconds`. Limits per key: `POST /orders` 30 a minute; the
        two shipment estimates 30 a minute together; every other endpoint 120 a
        minute together.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests. Slow down.
            code: RATE_LIMITED
            retry_after_seconds: 23
    ServerError:
      description: >-
        Our fault. Retry with backoff, with the same `Idempotency-Key` where the
        endpoint takes one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Something went wrong; retry with the same Idempotency-Key.
    ChainOrScreeningUnavailable:
      description: >-
        - `CHAIN_UNAVAILABLE`: we couldn't read a token's owner from the chain;
        retry shortly with the same `Idempotency-Key`.

        - `SCREENING_UNAVAILABLE`: wallet screening is briefly unavailable;
        retry shortly with the same `Idempotency-Key`.

        - `AUTH_UNAVAILABLE`, or no code: we couldn't check your key or load
        your program; retry after `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This wallet cannot redeem right now.
            code: SCREENING_UNAVAILABLE
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cb_live_<48 hex>
      description: >-
        Your API key (`cb_live_…`), sent as a bearer token, with the scope
        `nft:orders`. Keep it on your servers: never in a browser, app or
        wallet. Use a separate key per environment. A request from a country on
        our sanctions list gets a `403` with `Access denied`, whether or not it
        has a valid key. See [Authentication and
        keys](/partner-api/v2/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.