Skip to main content

Card details

PATCH 

/v1/cards/:id/details

Tag: api-baas-patch-card-detailsDescription: Retrieve card data. For virtual cards, return all information, including card number, CVV, expiration date, and the name printed on the card. For physical cards, return the masked card number data.

Request

Path Parameters

    id stringrequired

    Card ID.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses

Retrieve card found.

Schema
    id stringrequired

    Card ID.

    is_virtual booleanrequired

    Is Virtual Card.

    status stringrequired

    Possible values: [password_locked, activated, pending, blocked, cancelled, preventive_blocked]

    Status.

    number stringrequired

    Card Number.

    card_name stringrequired

    Card Name.

    expiry stringrequired

    Expiry Date.

    cvv stringrequired

    CVV.

    activated_at date-timerequired

    Card Activation Date.

Loading...