Saltar al contenido principal

Funciones de la API de Saldo

Obtener el saldo

Obtener el saldo de una cuenta de Stripe.

Punto final: https://api.stripe.com/v1/balance

Operación: GET

Ejemplos

Ejemplo de cURL:

curl -X GET `https://api.stripe.com/v1/balance` \
-u <CLAVE_SECRETA>:

Respuestas

Las respuestas devolverán códigos estándar.`

200: OK

{
"object": "balance",
"available": [
{
"amount": 0,
"currency": "usd",
"source_types": {
"card": 0
}
}
],
"livemode": false,
"pending": [
{
"amount": 0,
"currency": "usd",
"source_types": {
"card": 0
}
}
],
"refund_and_dispute_prefunding": {
"available": [
{
"amount": 0,
"currency": "usd"
}
],
"pending": [
{
"amount": 0,
"currency": "usd"
}
]
}
}

Respuestas de error

400: Bad Request

{
"error": {
"message": "Si pasas un array con claves explícitas (por ejemplo, foo[0]=a&foo[1]=b) en lugar de como un array (por ejemplo, foo[]=a&foo[]=b), las claves deben ser numéricas y secuenciales empezando por 0. Has pasado las claves `1`, esperábamos tener una clave con el valor `0`",
"param": "expand",
"request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
"type": "invalid_request_error"
}
}

401: No autorizado

{
"error": {
"type": "invalid_request_error",
"message": "Clave de API no válida proporcionada: sk_test_********************1234".
}
}

Parámetros

Parámetros de consulta
ParámetroTipoDescripción
expand[]array of stringsEspecifica qué campos de la respuesta deben expandirse.

Recuperar una transacción de saldo

Devuelve las transacciones que componen el saldo de la cuenta de Stripe (por ejemplo, cargos, transferencias, pagos, reembolsos, etc.). Las transacciones se devuelven ordenadas, apareciendo en primer lugar las transacciones más recientes.

Punto final: https://api.stripe.com/v1/balance_transactions/{id}

Operación: GET

Ejemplos

Ejemplo de cURL:

curl -X GET https://api.stripe.com/v1/balance_transactions/tr_1234567890 \
-u <CLAVE_SECRETA>:

Respuestas

Las respuestas devolverán códigos estándar.

200: OK

{
"object": "balance_transaction",
"id": "tr_1234567890",
"amount": 1000,
"currency": "usd",
"description": "Pago por factura",
"fee": 59,
"fee_details": [
{
"amount": 59,
"currency": "usd",
"description": "Tarifas de procesamiento de Stripe",
"type": "stripe_fee"
}
],
"net": 941,
"status": "available",
"type": "charge"
}

400: Bad Request

{
"error": {
"message": "Si pasas un array con claves explícitas (por ejemplo, foo[0]=a&foo[1]=b) en lugar de como un array (por ejemplo, foo[]=a&foo[]=b), las claves deben ser numéricas y secuenciales empezando por 0. Has pasado las claves `1`, esperábamos tener una clave con el valor `0`",
"param": "expand",
"request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
"type": "invalid_request_error"
}
}

401: No autorizado

{
"error": {
"type": "invalid_request_error",
"message": "Clave de API no válida proporcionada: sk_test_********************1234".
}
}

Parámetros

Parámetros de consulta
ParámetroTipoDescripción
expand[]array of stringsEspecifica qué campos de la respuesta deben expandirse.
Variables de ruta
NombreTipoObligatorioDescripción
idcadenaRequeridoIdentificador de la variable de ruta