API AvilaCash

Introduction

Base URL: https://api.avilacash.net

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by using the login endpoint.

Auth

Autenticación en el API

POST

https://api.avilacash.net

/api/login

Permite iniciar sesión en el API con las credenciales del aliado

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

Identificación del aliado en la plataforma

Example:

architecto

password

string

required

Contraseña del aliado

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

Example response:

{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjQyNDYzOWZhNDVjZDgyNzhhMzIwYTgzNDFmZDExZWU4NjUyMzNkNGM2MGUzODg4NWY1OWNhNWNiYmUwNTcxM2U0YjU3OWYxMTRiNDhjMTk0In0.eyJhdWQiOiIyIiwianRpIjoiNDI0NjM5ZmE0NWNkODI3OGEzMjBhODM0MWZkMTFlZTg2NTIzM2Q0YzYwZTM4ODg1ZjU5Y2E1Y2JiZTA1NzEzZTRiNTc5ZjExNGI0OGMxOTQiLCJpYXQiOjE1ODkwMzQ5OTgsIm5iZiI6MTU4OTAzNDk5OCwiZXhwIjoxNjIwNTcwOTk4LCJzdWIiOiIxMCIsInNjb3BlcyI6WyIqIl19.I_R9IDKsnZ04vJpkYKpyQ8-a7B6nPMQmwUmx4ZguG8grl15e6L5am8XMZ2WKFHm2PRxzRKLlCArDLIhRumRyYheJxiLeZ9Y0OVkC7SlVHU-NFASgiKGuo1ps1w3hSk-RcKqKxyqGhl5yrAuvZCnu4-wwriagMnv4F0EAj1835KVLPEdA1G53j39DMKziG9BwcGafPTgkui726e2P_4iro-EiImGokQCMAnFDrsm6CDDvtg0fLvZHrSsjqfPFR8ibeoLXBlJBQguThGylIJsj3FwVXue03FLFCrsflEncFpuRnaAEVWmdcsGuFm-Xh-Yx-2G_ekOpMq4DMuzK_gPbIgY3CCCUUWWzszLiw2IH-tt3poTTcMDXemKMyQdF7PqwhNZdtjT9z1Zl63zyvKWFJtjjyyVLjVBWfyl2wKLVFgXlmreLwggsgFgeS_xVX8x6urAMofBNKQGljYeqkXYnCjhCO_3LWWuAGBLPqELUAI93GmfMBECbqHfuyhF_mDRWAFf8iHhuMvcKGkJuY2u83Sd4y3JhvEgLq1ZJy6bAZNavArN3e7lBPX-owBfYkxDyT9-TPORq-Y35XMy4jyn-tfNzzw5d0Pz6z_Hg9iLWqXMLeKeYvQ9QUA-uaBtcmeRgiwjLakMmpC72GM2spoMCLq1KXWr-_TflCWsmQroOLuQ",
    "refresh_token": "def5020025f4648bd9831f69d469c4e8e28a6e48f08581a4be433d5713dad472770fb32f9703744684309b4a7b20522b39016d2060ad63d4cfac0bc4c92434ad4456f6551f5b32751ea662f15b36c88a081502acf6f622150cb12a167fc131f0008685e19cb0697a0e6e3c1bbe2918263a366d938c3b57d4452ffca61c1cca1d76bfab927f4ed7a2672c6baddb18cf8c579ddb428e70ec4dd99ec777ca013080b59e667fef0b272e958aac0f777053586492e52cda8a3aa95a49589937a79e46191f7cafb3d7d272a857c8e4e8eb90b95f054df7b28dc42a8fa5dd6adf30a13eb12817b2401fdd4900a1176be12ce3db3f488a835cc0ef21bb7b6b2551342f1dab100a3c9744092f47df7b9daef5b7f4445673c4ff0ec3cf478b21a1aeb9513c26e6987fe61a3b0d8b8a6342b0404eb621aaff7f1f56bb845012bef167e24c6e896c849f8b6dd627f72d382b3522a61deaa1d478b279ff7cdbaffc1d799af7df5bb9523394"
}

POST api/refresh

POST

https://api.avilacash.net

/api/refresh

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

refresh_token

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "refresh_token": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/refresh" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"refresh_token\": \"architecto\"
}"

GET api/logout

GET

https://api.avilacash.net

/api/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json

{
    "message": "Unauthenticated."
}

Bareca

API para integración con Bareca - Venta de pólizas de seguro

Esta API permite:

Consultar información y saldo de usuarios
Procesar ventas de pólizas (bloqueo de saldo)
Confirmar ventas procesadas
Cancelar ventas pendientes

Obtener información del usuario

POST

https://api.avilacash.net

/api/bareca/user-info

requires authentication

Devuelve los datos básicos y el saldo disponible de un usuario.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_id

integer

required

ID del usuario a consultar.

Example:

12345

Auth

Bearer

Headers

Body

{ "user_id": 12345 }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/bareca/user-info" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 12345
}"

Example response:

{
    "success": true,
    "data": {
        "nombre": "Juan",
        "apellido": "Pérez",
        "cedula": "V12345678",
        "email": "[email protected]",
        "telefono_1": "04121234567",
        "direccion": "Caracas, Venezuela",
        "balance": 1500.5
    }
}

Procesar venta de póliza

POST

https://api.avilacash.net

/api/bareca/process-sale

requires authentication

Crea una transacción pendiente y bloquea el saldo del usuario. La venta queda en estado "pendiente" hasta que se confirme o cancele.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_id

integer

required

ID del usuario sobre el que se valida y descuenta saldo (puede ser cliente final o el integrador).

Example:

12345

amount

numeric

required

Monto en Bs de la póliza.

Example:

150.00

amount_usd

numeric

required

Monto en USD de la póliza.

Example:

5.00

product

string

required

Tipo de póliza: rcv, salud, vida, vehiculo.

Example:

rcv

uuid

string

required

Identificador único de la transacción (formato: cedula_id).

Example:

V12345678_0001

destino

string

Información adicional del destino/beneficiario.

Example:

Placa ABC123

Auth

Bearer

Headers

Body

{ "user_id": 12345, "amount": "150.00", "amount_usd": "5.00", "product": "rcv", "uuid": "V12345678_0001", "destino": "Placa ABC123" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/bareca/process-sale" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 12345,
    \"amount\": \"150.00\",
    \"amount_usd\": \"5.00\",
    \"product\": \"rcv\",
    \"uuid\": \"V12345678_0001\",
    \"destino\": \"Placa ABC123\"
}"

Example response:

{
    "success": true,
    "message": "Transacción realizada exitosamente",
    "data": {
        "hash": "$2y$10$...",
        "uuid": "V12345678_0001",
        "status": "Saldo bloqueado",
        "transaction_id": 123456
    }
}

Confirmar venta

POST

https://api.avilacash.net

/api/bareca/confirm-sale

requires authentication

Confirma una venta pendiente y marca la transacción como completada. Una vez confirmada, el saldo queda debitado permanentemente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

UUID de la transacción a confirmar.

Example:

V12345678_0001

reference

string

Referencia externa de la póliza emitida.

Example:

POL-2024-001234

Auth

Bearer

Headers

Body

{ "uuid": "V12345678_0001", "reference": "POL-2024-001234" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/bareca/confirm-sale" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"V12345678_0001\",
    \"reference\": \"POL-2024-001234\"
}"

Example response:

{
    "success": true,
    "message": "Venta confirmada exitosamente",
    "data": {
        "uuid": "V12345678_0001",
        "status": "Completada",
        "confirmed_at": "2024-01-15T10:30:00-04:00"
    }
}

Cancelar venta

POST

https://api.avilacash.net

/api/bareca/cancel-sale

requires authentication

Cancela una venta pendiente y devuelve el saldo bloqueado al usuario. Solo se pueden cancelar transacciones en estado pendiente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

UUID de la transacción a cancelar.

Example:

V12345678_0001

reason

string

Motivo de la cancelación.

Example:

Cliente desistió de la compra

Auth

Bearer

Headers

Body

{ "uuid": "V12345678_0001", "reason": "Cliente desisti\u00f3 de la compra" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/bareca/cancel-sale" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"V12345678_0001\",
    \"reason\": \"Cliente desistió de la compra\"
}"

Example response:

{
    "success": true,
    "message": "Venta cancelada exitosamente",
    "data": {
        "uuid": "V12345678_0001",
        "status": "Cancelada",
        "refunded_amount": 150,
        "new_balance": 1650.5,
        "cancelled_at": "2024-01-15T10:30:00-04:00"
    }
}

Consultar estado de transacción

POST

https://api.avilacash.net

/api/bareca/transaction-status

requires authentication

Obtiene el estado actual de una transacción por su UUID.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

UUID de la transacción a consultar.

Example:

V12345678_0001

Auth

Bearer

Headers

Body

{ "uuid": "V12345678_0001" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/bareca/transaction-status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"V12345678_0001\"
}"

Example response:

{
    "success": true,
    "data": {
        "uuid": "V12345678_0001",
        "status": "Pendiente",
        "status_code": 1,
        "amount": 150,
        "product": "rcv",
        "user_id": 12345,
        "created_at": "2024-01-15T10:00:00-04:00",
        "updated_at": "2024-01-15T10:00:00-04:00"
    }
}

Endpoints

sendSms

POST

https://api.avilacash.net

/api/sms/send

requires authentication

Envia un SMS al numero de destino indicado

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

string

required

El número de teléfono destino

Example:

architecto

message

string

required

Must be at least 10 characters. Must not be greater than 160 characters.

Example:

mensaje

string

required

El mensaje a enviar, no debe superar los 160 caracteres

Example:

architecto

Auth

Bearer

Headers

Body

{ "numero": "architecto", "message": "g", "mensaje": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/sms/send" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": \"architecto\",
    \"message\": \"g\",
    \"mensaje\": \"architecto\"
}"

Example response:

{
    "success": true,
    "message": "Mensaje enviado",
    "recipient": "numero de destino"
}

sendSmsBatch

POST

https://api.avilacash.net

/api/avilacash/send-sms-batch

requires authentication

Envia un lote de SMS y procesa el envío en cola.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

message

string

required

Mensaje a enviar (10-160 caracteres)

Example:

architecto

numbers

string[]

required

Lista de números destino (máximo 5000)

Example:

["architecto"]

Auth

Bearer

Headers

Body

{ "message": "architecto", "numbers": [ "architecto" ] }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/send-sms-batch" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"architecto\",
    \"numbers\": [
        \"architecto\"
    ]
}"

recargaCelular

POST

https://api.avilacash.net

/api/avilacash/recarga-celular

requires authentication

Realiza la recarga OTA (Over The Air) al número indicado

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

string

required

El número de teléfono a recargar

Example:

architecto

monto

number

required

El monto a recargar

Example:

4326.41688

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

Body

{ "numero": "architecto", "monto": 4326.41688, "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-celular" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": \"architecto\",
    \"monto\": 4326.41688,
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"
}"

Example response:

{
    "success": true,
    "message": "Recarga procesada",
    "data": {
        "codigo_aprobacion": "0959400415",
        "code": "00",
        "uuid": "1234_56789"
    }
}

POST api/avilacash/recarga-celular-pos

POST

https://api.avilacash.net

/api/avilacash/recarga-celular-pos

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

string

required

Example:

architecto

monto

string

required

Must be between 0 and 999999.99 characters.

Example:

uuid

string

required

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

operadora

string

required

Must be one of:

movilnet_postpago
digitel_postpago

Example:

movilnet_postpago

Auth

Bearer

Headers

Body

{ "numero": "architecto", "monto": "n", "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "operadora": "movilnet_postpago" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-celular-pos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": \"architecto\",
    \"monto\": \"n\",
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",
    \"operadora\": \"movilnet_postpago\"
}"

recargaMovilInternacional

POST

https://api.avilacash.net

/api/avilacash/recarga-movil-internacional

requires authentication

Realiza la recarga OTA (Over The Air) de móviles internacionales

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

integer

required

El número de teléfono a recargar

Example:

monto

number

required

El monto a recargar

Example:

4326.41688

operadora

integer

required

El identificador de la operadora a recargar

Example:

pais

integer

required

El identificador del país de la operadora

Example:

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

product

string

The id of an existing record in the products table.

Auth

Bearer

Headers

Body

{ "numero": 16, "monto": 4326.41688, "operadora": 16, "pais": 16, "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "product": null }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-movil-internacional" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": 16,
    \"monto\": 4326.41688,
    \"operadora\": 16,
    \"pais\": 16,
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"
}"

Example response:

{
    "success": true,
    "message": "Recarga procesada",
    "data": {
        "codigo_aprobacion": "0959400415",
        "code": "00",
        "uuid": "1234_56789"
    }
}

recargaTV

POST

https://api.avilacash.net

/api/avilacash/recarga-tv

requires authentication

Realiza la recarga OTA (Over The Air) de TV por suscripción

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

abonado

integer

required

El número de contrato o SmartCard a recargar

Example:

monto

number

required

El monto a recargar

Example:

4326.41688

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

operadora

string

required

El nombre de la operadora a recargar (simple, cantv, intercable)

Example:

architecto

Auth

Bearer

Headers

Body

{ "abonado": 16, "monto": 4326.41688, "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "operadora": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-tv" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"abonado\": 16,
    \"monto\": 4326.41688,
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",
    \"operadora\": \"architecto\"
}"

Example response:

{
    "success": true,
    "message": "Recarga procesada",
    "data": {
        "codigo_aprobacion": "0959400415",
        "code": "00",
        "uuid": "1234_56789"
    }
}

Consulta Simple

POST

https://api.avilacash.net

/api/avilacash/consulta-simpletv

requires authentication

Devuelve información sobre la smartcard indicada para la operadora Simple TV

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

smartcard

string

required

El número de SmartCard a consultar

Example:

architecto

Auth

Bearer

Headers

Body

{ "smartcard": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/consulta-simpletv" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"smartcard\": \"architecto\"
}"

Example response:

{
    "success": true,
    "message": "Consulta exitosa",
    "extra": {
        "balance": 123456.78,
        "days_left": 365,
        "month_bill": 123456.78
    }
}

Consulta de saldo Inter y Cantv

POST

https://api.avilacash.net

/api/avilacash/consulta-saldo

requires authentication

Devuelve información sobre el contrato indicado para la operadora Inter

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

abonado

string

required

El número de contrato / telefono a consultar

Example:

architecto

operadora

string

required

El nombre de la operadora a consultar

Example:

architecto

Auth

Bearer

Headers

Body

{ "abonado": "architecto", "operadora": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/consulta-saldo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"abonado\": \"architecto\",
    \"operadora\": \"architecto\"
}"

recargaFijo

POST

https://api.avilacash.net

/api/avilacash/recarga-fijo

requires authentication

Realiza la recarga OTA (Over The Air) al número fijo indicado

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

string

required

El número de teléfono a recargar

Example:

architecto

monto

number

required

El monto a recargar

Example:

4326.41688

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

operadora

string

required

El nombre de la operadora a recargar (digitel_fijo, movistar_fijo)

Example:

architecto

Auth

Bearer

Headers

Body

{ "numero": "architecto", "monto": 4326.41688, "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "operadora": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-fijo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": \"architecto\",
    \"monto\": 4326.41688,
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",
    \"operadora\": \"architecto\"
}"

Example response:

{
    "success": true,
    "message": "Recarga procesada",
    "data": {
        "codigo_aprobacion": "0959400415",
        "code": "00",
        "uuid": "1234_56789"
    }
}

recargaPin

POST

https://api.avilacash.net

/api/avilacash/recarga-pin

requires authentication

Realiza la compra de un pin de servicio

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

El pin a comprar

Example:

architecto

operadora

string

required

El nombre de la operdora del pin

Example:

architecto

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

Body

{ "pin": "architecto", "operadora": "architecto", "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-pin" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pin\": \"architecto\",
    \"operadora\": \"architecto\",
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"
}"

Example response:

{
"success": true,
"data": [
{
"uuid": "1234_56789",
"operadora": "netflix",
"monto": "20000",
"code": "2509071547497847",
"message": "Recarga exitosa"
"url": "https://www.netflix.com/redeem"
}
]
}

getTransactionByUUID

GET

https://api.avilacash.net

/api/avilacash/transaction

requires authentication

Obtiene el detalle de la transaccion dada

Este método acepta solo un parámetro, el UUID de la transacción

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

UUID de la transacción

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

Body

{ "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed" }

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/avilacash/transaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"
}"

Example response:

{
    "success": true,
    "data": {
        "details": {
            "external_uuid": "4444",
            "destino": "04168647870",
            "producto": "movilnet_pin",
            "monto": "5000.00",
            "dateTime": "2020-01-16 18:32:35",
            "code": "1104426271668729",
            "barcode": "0000005160250778",
            "mensaje": null,
            "status": "aprobado"
        }
    }
}

recargaAmazonPrime

POST

https://api.avilacash.net

/api/avilacash/recarga-amazon

requires authentication

Realiza la recarga OTA (Over The Air) de Amazon Prime Video

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

numero

string

required

El número de telefono con el 0 al inicio, a asociar o ya asociado a la suscripción de Prime Video

Example:

architecto

uuid

string

required

Identificador único para la transacción, debe estar compuesto por el nombre de usuario seguido de una cadena unica. Ejm: 1234567_0000012345

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

Body

{ "numero": "architecto", "uuid": "6ff8f7f6-1eb3-3525-be4a-3932c805afed" }

Received response

Example request:

curl --request POST \
    "https://api.avilacash.net/api/avilacash/recarga-amazon" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"numero\": \"architecto\",
    \"uuid\": \"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"
}"

Example response:

{
    "success": true,
    "message": "Recarga procesada",
    "data": {
        "url": "https://is.gd/123456",
        "code": "00",
        "uuid": "1234_56789"
    }
}

getRate

GET

https://api.avilacash.net

/api/avilacash/get-rate/{iso}

requires authentication

Retorna la tasa de cambio actual para los servicios internacionales

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

iso

string

required

Example:

architecto

Body Parameters

iso

string

required

el ISO de la moneda a consultar (COP, USD)

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "iso": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/avilacash/get-rate/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"iso\": \"architecto\"
}"

Example response:

{
    "success": true,
    "message": "Tasa de cambio obtenida",
    "currency": "COP|USD",
    "rate": 1234.56,
    "client_rate": 1234.56
}

getServices

GET

https://api.avilacash.net

/api/avilacash/get-services/{country?}

requires authentication

Obtiene los servicios disponibles para recarga

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

country

string

Example:

architecto

Body Parameters

country

string

optional El código del país, en caso de no incluirlo se devolverá la lista completa de servicios disponibles para cada país

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "country": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/avilacash/get-services/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country\": \"architecto\"
}"

Example response:

{
"success": true,
"message": "Servicios disponibles",
data": [
{
"id": 6,
"country_id": 2,
"active": 1,
 "name": "Movistar Colombia",
 "slug": "movistar_co",
 "description": "Movilnet Móvil Colombia",
"image": "",
 "icon": "",
 "created_at": "2023-06-21T00:26:57.000000Z",
 "updated_at": "2023-06-21T00:26:57.000000Z",
 "transaction_type_id": 4,
 "products": [
   {
     "id": 47,
     "product": "Movistar Prepago Colombia",
     "slug": "movistar_co",
     "description": "Movistar Prepago Colombia",
     "image": "",
     "icon": "",
     "active": 1,
     "service_id": 6,
     "country_id": 2,
     "currency_id": 1,
     "price": "0.00",
     "sell_price": "0.00",
     "type": "mobile",
     "product_code": "movistar_co",
     "created_at": "2023-06-24T04:32:32.000000Z",
     "updated_at": "2023-06-24T04:32:32.000000Z",
     "min": "1000.00",
     "max": "50000.00",
     "multiplo": "1000.00"
   }
 ],
"country": {
   "id": 2,
   "sortname": "COL",
   "name": "Colombia",
   "created_at": "2023-06-20T18:09:17.000000Z",
   "updated_at": "2023-06-20T18:09:17.000000Z",
   "active": 1,
   "currency_id": 1,
   "flag": null,
   "currency": {
     "id": 1,
     "iso": "COP",
     "currency": "Peso Colombiano",
     "rate": "119",
     "rate_p": "0.00",
     "created_at": "2020-05-16T16:34:00.000000Z",
     "updated_at": "2023-06-23T23:39:57.000000Z"
   }
 }
},
]

GET api/avilacash/user

GET

https://api.avilacash.net

/api/avilacash/user

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/avilacash/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 600
                                                                                                                    x-ratelimit-remaining
                                                            : 597

{
    "profile": null
}

fetchBalance

GET

https://api.avilacash.net

/api/avilacash/saldo

requires authentication

Devuelve el saldo disponible del aliado basado en su token de autenticación

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.avilacash.net/api/avilacash/saldo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "success": true,
    "data": {
        "balance": 123456.78
    }
}

API AvilaCash

API AvilaCash

Introduction

Authenticating requests

Auth

Login

Headers

Body Parameters

POST api/refresh

Headers

Body Parameters

GET api/logout

Headers

Bareca

Obtener información del usuario

Headers

Body Parameters

Procesar venta de póliza

Headers

Body Parameters

Confirmar venta

Headers

Body Parameters

Cancelar venta

Headers

Body Parameters

Consultar estado de transacción

Headers

Body Parameters

Endpoints

sendSms

Headers

Body Parameters

sendSmsBatch

Headers

Body Parameters

recargaCelular

Headers

Body Parameters

POST api/avilacash/recarga-celular-pos

Headers

Body Parameters

recargaMovilInternacional

Headers

Body Parameters

recargaTV

Headers

Body Parameters

Consulta Simple

Headers

Body Parameters

Consulta de saldo Inter y Cantv

Headers

Body Parameters

recargaFijo

Headers

Body Parameters

recargaPin

Headers

Body Parameters

getTransactionByUUID

Headers

Body Parameters

recargaAmazonPrime

Headers

Body Parameters

getRate

Headers

URL Parameters

Body Parameters

getServices

Headers

URL Parameters

Body Parameters

GET api/avilacash/user

Headers

fetchBalance

Headers