Uso del token de acceso

Endpoint

URL del sandbox:
POST https://sandbox.tropipay.me/api/v3/access/token

URL de producción https://www.tropipay.com/api/v3/access/token

Descripción

Este endpoint se utiliza para obtener un token de acceso usando el tipo de concesión de credenciales de cliente. El token de acceso es necesario para autenticar las solicitudes a la API.

Encabezados

Clave	Valor	Descripción
Content-Type	application/json	Especifica el formato del cuerpo de la solicitud.
User-Agent	YourAppName/Version	(Opcional) Identifica al cliente que realiza la solicitud.

Cuerpo de la solicitud

El cuerpo de la solicitud debe enviarse como JSON e incluir los siguientes parámetros:

Parámetro	Tipo	Requerido	Descripción
grant_type	string	Sí	Debe establecerse en client_credentials.
client_id	string	Sí	El client ID proporcionado por Tropipay.
client_secret	string	Sí	El client secret proporcionado por Tropipay.

Ejemplo de solicitud (cURL)

curl --request POST \
  --url https://tropipay-dev.herokuapp.com](https://sandbox.tropipay.me/api/v3/access/token \
  --header 'Content-Type: application/json' \
  --data '{
    "grant_type": "client_credentials",
    "client_id": "your_client_id",
    "client_secret": "your_client_secret"
  }'

Respuesta

Una solicitud exitosa devuelve un objeto JSON que contiene el token de acceso.

Ejemplo de respuesta

{
  "access_token": "your_access_token",
  "refresh_token": "your_refresh_token",
  "token_type": "Bearer",
  "expires_in": 1741987517,
  "scope": "ALLOW_EXTERNAL_CHARGE ALLOW_CREATE_BENEFICIARY ALLOW_UPDATE_BENEFICIARY ALLOW_PAYMENT_IN ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_PROFILE_DATA ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_POS_MOVEMENT_BY_CREDENTIALS"
}

Parámetros de la respuesta

Parámetro	Tipo	Descripción
access_token	string	El token a usar para la autenticación de la API.
refresh_token	string	Un token usado para obtener un nuevo access token.
token_type	string	El tipo de token, típicamente Bearer.
expires_in	number	Duración de validez del token en segundos.
scope	string	Los permisos concedidos al token.

Manejo de errores

Si la solicitud falla, la API devuelve una respuesta de error. Las respuestas de error comunes incluyen:

Estado HTTP	Código de error	Descripción
400	invalid_request	Parámetros faltantes o inválidos.
401	invalid_client	Credenciales de cliente inválidas.
403	forbidden	Acceso no autorizado.

Ejemplo de respuesta de error

{
	"error": {
		"type": "VALIDATION_ERROR",
		"code": "VALIDATION_ERROR",
		"message": "Credential not found",
		"details": [],
		"i18n": "Parámetros inválidos"
	}
}

tip

• Asegúrate de mantener seguros tu client_id y client_secret.
• El access_token debe incluirse en el encabezado Authorization de las solicitudes posteriores a la API.
• Los tokens normalmente expiran después de un período determinado (expires_in), y se debe solicitar un nuevo token cuando expiren.