PaymentMethod

Representa a un método de pago configurable para la Company. Se suele necesitar SDK para implementar.

El atributo name contiene el nombre del gateway a usar. Por ejemplo: "stripe", "paypal", etc.

El atributo config contiene la información de claves a utilizar para inicializar el SDK.

Los atributos tax_percent y tax_flat_e2 contienen información de impuestos adicionales a cobrar por usar el método de pago. Vea Formularios en la descripción de currency para más información.

El campo currency_iso contiene el ISO de la moneda para mostrar el impuesto aplicado.

Modelo PaymentMethod

{
    "id": 19,
    "name": "stripe",
    "config": {
        "public_key": "pk_test_FdMRjWhvmpDlQATdzn1IgwTl",
        "secret_key": "sk_test_qOc9zLm2kowVdEpQEpQtrZk3",
        "whitelist": [],
        "blacklist": []
    },
    "enabled": true,
    "tax_percent": 0.03,
    "tax_flat_e2": 30,
    "created_at": "2020-05-05 01:48:43",
    "updated_at": "2025-01-16 19:50:42",
    "currency_iso": "USD",
    "branch_id": null
}
Atributo Tipo Descripción
id int -
name string -
config array -
enabled bool -
tax_percent float -
tax_flat_e2 int -
created_at datetime\|null -
updated_at datetime\|null -
currency_iso string -

Insertar PaymentMethod

Store a newly created resource in storage.

Método URI Cabeceras
POST /companies/{company}/payment-methods Authorization 
{
    "name": "required|string|in:paypal,instapago,zelle,payco,stripe,balance,pos,banco_de_venezuela,binance,post-payment",
    "enabled": "required|boolean",
    "config": "required",
    "tax_percent": "numeric|between:0.0000,1.0000",
    "tax_flat_e2": "integer|min:0",
    "currency_iso": "required_with:tax_flat_e2|string|min:3|max:8"
}

Listar PaymentMethod

Muestra los métodos de pago de una Company.

Sólo aplica si la Company tiene is_marketplace = true

Método URI Cabeceras
GET /companies/{company}/payment-methods Authorization

Actualizar PaymentMethod

Método URI Cabeceras
PATCH /companies/{company}/payment-methods/{payment_method} Authorization 
{
    "name": "string|max:32|in:paypal,instapago,zelle,payco,stripe,balance,pos,banco_de_venezuela,binance,post-payment",
    "enabled": "boolean",
    "config": "required",
    "tax_percent": "numeric|between:0.0000,1.0000",
    "tax_flat_e2": "integer|min:0",
    "currency_iso": "required_with:tax_flat_e2|string|min:3|max:8"
}

Eliminar PaymentMethod

Método URI Cabeceras
DELETE /companies/{company}/payment-methods/{payment_method} Authorization

Acciones de PaymentMethod

Index For Branch

Muestra los métodos de pago de un Comercio.

Sólo aplica si la Company tiene is_marketplace = false

Método URI Cabeceras
GET /companies/{company}/branches/{branchId}/payment-methods Authorization

Show Tax

Método URI Cabeceras
GET /companies/{company}/payment-methods/{name}/get-tax Authorization 
{
    "order_e2": "required|integer|min:0",
    "tip_e2": "required|integer|min:0",
    "currency_to_use": "string|min:3|max:8",
    "branch_id": "nullable|integer"
}

Get User

Obtener UserId del método de Pago

Se utiliza para registrar y vincular el UserId del método de Pago. Por ejemplo, en el caso de Stripe, se genera el CustomerId de Stripe y se vincula al Cliente. De esta forma, se podrá acceder al wallet de tarjetas y métodos de pago tercerizados.

Método URI Cabeceras
GET /companies/{company}/payment-methods/{payment_method}/get-user Authorization 
{
    "client_id": "required|integer|exists:clients,id"
}

Get Cards

Obtener Tarjetas de un usuario

Método URI Cabeceras
GET /companies/{company}/payment-methods/{payment_method}/cards Authorization 
{
    "client_id": "required|integer|exists:clients,id"
}

Store Card

Guardar Tarjeta a un usuario

Método URI Cabeceras
POST /companies/{company}/payment-methods/{payment_method}/cards Authorization 
{
    "client_id": "required|integer|exists:clients,id",
    "source": "required|string"
}

Delete Card

Eliminar Tarjeta a un usuario

Método URI Cabeceras
DELETE /companies/{company}/payment-methods/{payment_method}/cards Authorization 
{
    "client_id": "required|integer|exists:clients,id",
    "card_id": "required|string"
}

Select Card

Marca una tarjeta de un usuario como seleccionada

Método URI Cabeceras
POST /companies/{company}/payment-methods/{payment_method}/select-card Authorization 
{
    "client_id": "required|integer|exists:clients,id",
    "card_id": "required|string"
}

Index For Set Up

Método URI Cabeceras
GET /companies/{company}/payment-methods/set-up Authorization

Index For Branch Set Up

Método URI Cabeceras
GET /companies/{company}/branches/{branchId}/payment-methods/set-up Authorization

Store For Branch

Método URI Cabeceras
POST /companies/{company}/branches/{branchId}/payment-methods Authorization 
{
    "name": "required|string|in:paypal,instapago,zelle,payco,stripe,balance,pos,banco_de_venezuela,binance,post-payment",
    "enabled": "required|boolean",
    "config": "required",
    "tax_percent": "numeric|between:0.0000,1.0000",
    "tax_flat_e2": "integer|min:0",
    "currency_iso": "required_with:tax_flat_e2|string|min:3|max:8"
}

Enlaces de PaymentMethod