Skip to main content

Create transaction capture

POST 
/v1/payin/:id/captures
Description: Creates total capture for an already authorized transactionAuthentication: Required via JWT Bearer tokenProcess: 1. Validate user authentication and input parameters 2. Verify transaction exists and belongs to the user 3. Validate transaction status (AUTHORIZED) 4. Check if capture amount is valid 5. Create capture request with PENDING status 6. Asynchronous processingBusiness Rules: - Accepted statuses: AUTHORIZED - Rejected statuses: WAITING, PENDING, CANCELLED, DECLINED, SETTLED - Maximum amount: Cannot exceed remaining authorized amount

Request​

Path Parameters

    id uuidrequired

    Unique identifier of the transaction to be captured

      <b>Format</b>: UUID v7
      <b>Validation</b>: Must exist and belong to the authenticated user

Header Parameters

    x-wallet-uuid string

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

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v7) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    amount_total integerrequired

    Possible values: <= 9007199254740991

    Capture amount in cents

      <b>Format</b>: Positive integer
      <b>Example</b>: 10000 (equals $ 100.00)
      <b>Validation</b>: Must be positive and equal to the authorized amount
    currency_tag object required

    Possible values: [MXN]

    Payment currency ISO 4217 code.

    oneOf

    string

    Possible values: [MXN]

Responses​

✅ Capture request created successfully

  <b>Returns</b>: Created capture request object
  <b>Initial status</b>: PENDING (awaiting asynchronous processing)
  <b>Next steps</b>: Monitor status via webhook or subsequent query
Schema
    id uuidrequired

    Unique identifier of the capture request Format: UUID v7 Usage: For tracking capture status Important: This is the capture ID, not the original transaction ID

    amount integerrequired

    Capture amount in cents Format: Positive integer

    currencyTag stringrequired

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

    Currency of the capture Format: ISO 4217 currency code

    country stringrequired

    Possible values: [MEX]

    Country of the capture Format: ISO 3166-1 alpha-3 code

    created_at date-timerequired

    Creation date of the capture request

Loading...