Skip to main content

Get capture by ID

GET 
/v1/payin/captures/:captureId
Description: Retrieves capture details by its unique identifierAuthentication: Required via JWT Bearer tokenProcess: 1. Validate user authentication and input parameters 2. Verify capture exists and belongs to the user 3. Return capture detailsResponse includes: - Capture ID and status - Associated transaction ID - Amount and currency - External ID from PSP - Creation and update timestamps

Request​

Path Parameters

    captureId uuidrequired

    Capture 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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Capture details retrieved successfully

Schema
    id uuidrequired

    Capture ID

    transaction_id uuidrequired

    Transaction ID to which the capture belongs

    amount integerrequired

    Capture amount in cents

    currency_tag stringrequired

    Possible values: [MXN, PEN, CLP, ARS, USD, BRL]

    Currency tag

    country stringrequired

    Possible values: [BRA, ARG, CHL, PER, MEX]

    Country code

    status stringrequired

    Possible values: [PENDING, WAITING, AUTHORIZED, FAILED, ERROR]

    Capture status

    created_at date-timerequired

    Creation date

    updated_at date-timerequired

    Last update date

Loading...