Consultar Saldo

Consultar Saldo de Cuenta

Dirección de Solicitud

GET /v1/balance

Autenticación

Utiliza Autenticación Básica HTTP. Añada Authorization en el encabezado HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Este bloque de código se muestra en una ventana flotante

El base64_auth_string se genera mediante: base64(dev_key:dev_secret)

Ejemplo de Solicitud

Encabezado de Solicitud

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Este bloque de código se muestra en una ventana flotante

Cuerpo de Solicitud

Ninguno

Parámetros de Solicitud

Ninguno

Parámetros de Respuesta

Respuesta Exitosa

Campo	Tipo	Opción	Descripción
balance10000	Integer	Obligatorio	Saldo normal, valor entero multiplicado por 10000
gift_balance10000	Integer	Obligatorio	Saldo de regalo, valor entero multiplicado por 10000
balance	Number	Obligatorio	Saldo normal, punto flotante
gift_balance	Number	Obligatorio	Saldo de regalo, punto flotante
total_balance10000	Integer	Obligatorio	Saldo total, suma del saldo normal y el saldo de regalo, valor entero multiplicado por 10000
total_balance	Number	Obligatorio	Saldo total, suma del saldo normal y el saldo de regalo, punto flotante

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

Este bloque de código se muestra en una ventana flotante

Se recomienda que los llamadores utilicen preferentemente los campos balance10000, gift_balance10000 y total_balance10000 para formatear el saldo por sí mismos, evitando problemas de precisión de punto flotante.

Respuesta Fallida

El código de estado HTTP es 4xx o 5xx, el cuerpo de la respuesta contiene los siguientes campos:

Campo	Tipo	Opción	Descripción
code	int	Obligatorio	Código de error, consulte Códigos de Error para más detalles
message	String	Obligatorio	Detalles del error

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

Este bloque de código se muestra en una ventana flotante

Códigos de Error

Código de Error	HTTP Code	Descripción
1000	500	Error interno, por favor intente nuevamente más tarde
2001	401	Autenticación fallida, no se proporcionó el token correcto, o el comerciante correspondiente al token no existe
2002	401	Autenticación fallida, el token ha expirado o ha sido deshabilitado
2002	403	El comerciante ha sido eliminado