Get a payment transaction by UUID

Returns one payment transaction by its uuid. Use it when the customer comes back to your external_redirect: the transaction_token query parameter is the uuid. Check status here instead of trusting the status in the redirect URL.

This call only reads what HQ has stored. To ask the gateway for the latest result of an open or failed transaction, use "Re-check a payment transaction".

Responses

🟢200OK

application/json

The transaction under the payment_gateways_transaction key. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "payment_gateways_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

Get a payment transaction by UUID

Request

Responses