Etiquetas de Pago

Etiquetas de pago es un recurso que sirve para la consulta de las etiquetas de pago asignadas a los pagos y letras programados.‌

En la API v3 de Sperant se podrá Listar etiquetas de Pago y mostrar una etiqueta de pago determinada:

Listar Etiquetas de Pago

GET https://api.sperant.com/v3/payment_tags

Permite listar información de todas las etiquetas de pago:

Path Parameters

Name
Type
Description

Authorization

string

Token entregado.

{
    "data": [
        {
            "type": "payment_tags",
            "id": "29",
            "attributes": {
                "id": 29,
                "name": "Premio del buen pagador",
                "status": true,
                "optional-code": ""
            }
        },
        {
            "type": "payment_tags",
            "id": "28",
            "attributes": {
                "id": 28,
                "name": "Pagos Aplazados",
                "status": true,
                "optional-code": ""
            }
        },
        {
            "type": "payment_tags",
            "id": "27",
            "attributes": {
                "id": 27,
                "name": "reserva",
                "status": true,
                "optional-code": ""
            }
        }
    ]
}

Parámetros de retorno

Parámetro

Tipo de Dato

Descripción

id

integer

Identificador de la etiqueta de pago.

name

string

Nombre de la etiqueta de pago.

status

boolean

Estado de la etiqueta de pago.

optional-code

string

Código opcional de la etiqueta de pago.

Mostrar Etiqueta de Pago

GET https://api.sperant.com/v3/payment_tags/<id>

Permite mostrar información de una etiqueta de pago específica:

Path Parameters

Name
Type
Description

Authotization

string

Token entregado.

{
    "data": {
        "type": "payment_tags",
        "id": "24",
        "attributes": {
            "id": 24,
            "name": "Bono Familiar Habitacional",
            "status": true,
            "optional_code": "BFH"
        }
    }
}

Parámetros de retorno

Parámetro

Tipo de Dato

Descripción

id

integer

Identificador de la etiqueta de pago.

name

string

Nombre de la etiqueta de pago.

status

boolean

Estado de la etiqueta de pago.

optional-code

string

Código opcional de la etiqueta de pago.

Última actualización