Capture

This endpoint is used to capture a previously authorized payment transaction. It requires a JSON payload containing transaction details, capture information, and device information.

The URL for this endpoint is https://api.firstoken.co/v1/payments/:id/capture

In case of sandbox environment you should use this URL: https://api.firstoken-staging.co/v1/payments/:id/capture

Request Headers

• Content-Type: application/json

• x-api-key: <Your API Key>

Params of the request

id: string

The unique identifier of the transaction to be captured.

Attributes of the request

• transaction_info: {object}

  • type Type of transaction. Possible values: capture.

  • reference_code Unique reference code for the transaction.

• capture_info: {object}

  • amount_details

    • total_amount Total amount to be captured.

    • currency Currency code (e.g., MXN for Mexican Peso).

  • installments Number of installments for the capture.

• device_info: {object}

  • ip_address IP address of the device making the request.

Attributes of the response

• status Status of the response. Possible values: success, error.

• message Message describing the result of the capture.

• data {object}

  • transaction_info {object}

    • type Type of transaction response. Possible values: capture_response.

    • reference_code Unique reference code for the transaction.

    • transaction_id Unique transaction ID.

    • request_id Unique request ID.

    • status Status of the transaction. Possible values: Pending, Captured, Declined.

    • reconciliation_id Reconciliation ID for the transaction.

    • created_at Timestamp of when the transaction was created.

  • order_info {object}

    • amount_details {object}

      • total_amount Total amount captured.

      • currency Currency code.

Request Body

The request body should be a JSON object with the following structure:

Example of the JSON request

{
  "transaction_info": {
    "type": "capture",
    "reference_code": "123456789"
  },
  "capture_info": {
    "amount_details": {
      "total_amount": 1000,
      "currency": "MXN"
    },
    "installments": 1
  },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}

Response

The response will be a JSON object with the following structure:

Example of the JSON response

{
    "status": "success",
    "message": "Capture successful",
    "data": {
        "transaction_info": {
            "type": "capture_response",
            "reference_code": "123456789",
            "transaction_id": "0001733749102035492129",
            "request_id": "7337491022116075204953",
            "status": "Pending",
            "reconciliation_id": "hrklh3wWGoek",
            "created_at": "2024-12-09T12:58:22Z"
        },
        "order_info": {
            "amount_details": {
                "total_amount": "1000.00",
                "currency": "MXN"
            }
        }
    }
}

In case of an error, the response will have a status of fail and a descriptive message. The data object provides more details about the specific issues encountered.