API documentation

v1.0

Payment methods

The payment methods offer the possibility of defining how we want the issued invoices to be paid.

List payment methods

This endpoint allows the consultation of payment methods from your application.

HTTP Request

GET/payment-methods

GET Parameters

NameTypeDescription
pageInteger / Optional / Min:1Page
per_pageInteger / Optional / Min:1 Max:100Items per page

200 Response

{
    "data": [
        {
            "id": 2,
            "name": {
                "en": "PayPal"
            },
            "description": {
                "en": "PayPal payment to paypal@orzame.com"
            },
            "default": false,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 1,
            "name": {
                "es": "Transferencia bancaria",
                "en": "Bank transfer"
            },
            "description": {
                "es": "Transferencia bancaria al nĂºmero XXXX-XXXX-XX-XXXXXXX",
                "en": "Bank transfer to XXXX-XXXX-XX-XXXXXXX"
            },
            "default": true,
            "created_at": "2022-09-29T15:30:15+00:00",
            "updated_at": "2022-09-29T15:30:15+00:00"
        }
    ],
    "links": {
        "first": "http:\/\/api.orzame.com\/v1\/payment-methods?page=1",
        "last": "http:\/\/api.orzame.com\/v1\/payment-methods?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/api.orzame.com\/v1\/payment-methods",
        "per_page": 100,
        "to": 2,
        "total": 2
    }
}

Get a payment method

This endpoint allows the consultation of a payment method from your application.

HTTP Request

GET/payment-methods/{id}

200 Response

{
    "data": {
        "id": 1,
        "name": {
            "es": "Transferencia bancaria",
            "en": "Bank transfer"
        },
        "description": {
            "es": "Transferencia bancaria al numero XXXX-XXXX-XX-XXXXXXX",
            "en": "Bank transfer to XXXX-XXXX-XX-XXXXXXX"
        },
        "default": true,
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}