Skip to main content

Get all captures

GET 
/v1/payin/captures
Description: Retrieves all captures of the userAuthentication: Required via JWT Bearer tokenProcess: 1. Validate user authentication and input parameters 2. Verify captures exists and belongs to the user 3. Return paginated list of capturesPagination: - Use 'page' parameter to navigate through results - Use 'size' parameter to control page size - Use 'sort' and 'order' parameters to sort resultsResponse includes: - Pagination metadata - List of captures with their details - Each capture includes ID, status, amount, currency, and timestamps

Request​

Path Parameters

    id stringrequired

    Capture ID

Query Parameters

    page number

    Default value: 1

    Page number, starting from 1. Default is 1.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Default is 10.

    sort string

    Sort field.

    order string

    Possible values: [ASC, DESC]

    Sort order.

    country string

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

    Country code filter.

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​

Captures retrieved successfully

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    List of captures

  • Array [
    • 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...