List payment methods

Returns the active payment methods of the account, with their gateway. Methods of deleted gateways are not returned. Use a method id to start a payment with "Create a payment transaction" or "Get a payment button".

Responses

🟢200OK

application/json

A page of payment methods. 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

{
    "current_page": 1,
    "data": [
        {
            "id": 3,
            "handle": "card_usd",
            "name": "Credit card",
            "label": "Credit card",
            "active": true,
            "gateway_id": 2,
            "currency": "usd",
            "fixed_amount": "0.30",
            "percentage": "2.90",
            "allowed_countries": null,
            "gateway": {
                "id": 2,
                "label": "Stripe",
                "adapter": "stripe_sca",
                "active": true,
                "test_mode": false
            }
        }
    ],
    "first_page_url": "https://api.hqrentals.app/api/payment-gateways/methods?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.hqrentals.app/api/payment-gateways/methods?page=1",
    "links": [],
    "next_page_url": null,
    "path": "https://api.hqrentals.app/api/payment-gateways/methods",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Request

Responses