API documentation

v1.0

Métodos de pago

Los métodos de pago ofrecen la posibilidad de definir cómo queremos que las facturas emitidas sean pagadas.

Listar métodos de pago

Este endpoint permite la consulta de los métodos de pago de tu aplicación.

Petición HTTP

GET/payment-methods

Parámetros GET

NombreTipoDescripción
pageEntero / Opcional / Min:1Página
per_pageEntero / Opcional / Min:1 Max:100Elementos por página

200 Respuesta

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

Obtener un método de pago

Este endpoint permite la consulta de un método de pago de tu aplicación.

Petición HTTP

GET/payment-methods/{id}

200 Respuesta

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