Re-check a payment transaction

Asks the payment gateway for the latest result of a transaction and returns the updated transaction. Use it when a transaction is still open or failed after the customer has left the payment page.

Only open and failed transactions are re-checked, and only on gateways that support it; other transactions are returned unchanged. If the gateway reports the payment as paid, the transaction becomes paid and HQ applies the payment to the item. A transaction that is still open 24 hours after it was created becomes expired.

Responses

🟢200OK

application/json

The transaction in data.transaction. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "transaction": {
            "id": 5512,
            "uuid": "8c1f7c1e-2b9a-4a51-9d1e-6f2a0b0f3c11",
            "item_type": "car_rental.reservations",
            "item_id": 1052,
            "contact_type": "contacts",
            "contact_id": 30,
            "gateway_id": 2,
            "method_id": 3,
            "label": "Reservation #1052",
            "description": "Rental deposit",
            "amount": "150.00",
            "refunded_amount": "0.00",
            "currency": "usd",
            "status": "paid",
            "status_description": "Approved",
            "reference": "pi_3PZ0example",
            "authorization": false,
            "external_redirect": "https://www.example.com/booking/1052/paid",
            "external_url": "https://yourcompany.example.com/public/payment-gateways/payment-transactions/8c1f7c1e-2b9a-4a51-9d1e-6f2a0b0f3c11/external"
        }
    }
}

🟠404Record Not Found

Request

Responses