Payment Methods

Payment Method Index Endpoint

Structure

See View Payment Method Endpoint for the structure of the payment method payload inside the data array.

Example Request

GET /api/payment-methods?per_page=2

Example Response

{
    "current_page": 1,
    "data": [
        //...
    ],
    "first_page_url": "http://aero.test/api/payment-methods?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://aero.test/api/payment-methods?page=1",
    "next_page_url": null,
    "path": "http://aero.test/api/payment-methods",
    "per_page": 2,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}

See View Payment Method Endpoint for the structure of the payment method payload inside the data array.

View Payment Method Endpoint

Structure

Name
Type
Description
id int The id of the payment method
name string The name of the payment method
driver string The driver for the payment method
available boolean Whether the payment method is available for use

Example Request

GET /api/payment-methods/{id}

Example Response

{
    "id": 1,
    "name": "Cash",
    "driver": "cash",
    "available": true
}