Saltar al contenido principal

Balances

La API de Balances permite obtener información sobre el saldo disponible de tus clientes dentro de Amplify.

Las cuentas de tipo MARKETPLACE son las únicas que pueden acceder a esta información, ya que el saldo disponible se refiere a los fondos que los clientes tienen en sus cuentas de Amplify, y no a los fondos que el marketplace tiene en su cuenta principal.

API

Obtener balance de un cliente​

[GET] /receiver/:receiverId

Obtiene el saldo disponible de un cliente específico.

Headers requeridos​

Este endpoint requiere autenticación mediante los siguientes headers:

{
  "apiKey": "123xxx456",
  "clientId": "123xxx456"
}

Parámetros​

  • receiverId (requerido): Identificador único del cliente cuyo saldo se desea consultar.

Respuesta​

{
  "available": 1234,
  "inTransit": 500,
  "rate": 1000
}

Campos de la respuesta​

  • available: Saldo disponible del cliente.
  • inTransit: Saldo en tránsito (fondos en proceso de retiro).
  • rate: Tipo de cambio aplicado al momento de la consulta.
  • inTransit: Fondos que están en proceso de ser transferidos.