Transferencias entre cuentas

Transferencia de dinero de una cuenta a otra con comisión: alta, edición y baja. Sus partes son movimientos de dinero con transfer_id.

Cargando el índice de búsqueda…

Transferencias entre cuentas

Objetos

MoneyTransfer

  • idintegerobligatorio

    ID de la transferencia: el transfer_id de sus partes en el libro de movimientos de dinero (/v1/money-transactions).

  • versionintegerobligatorio

    Versión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.

  • from_account_idintegerobligatorio

    ID de la cuenta de dinero de la que salió el dinero.

  • to_account_idintegerobligatorio

    ID de la cuenta de dinero a la que entró el dinero.

  • from_amountstringobligatorio

    Importe que salió de from_account_id en su moneda, como cadena decimal.

  • from_currencystringobligatorio

    Moneda de la cuenta de origen: código ISO 4217 o código de la criptomoneda.

  • to_amountstringobligatorio

    Importe que entró en to_account_id en su moneda, como cadena decimal. En la misma moneda es igual a from_amount: la diferencia es la comisión fee.

  • to_currencystringobligatorio

    Moneda de la cuenta de destino.

  • feestring o nullobligatorio

    Comisión de la transferencia en la moneda de la cuenta de origen, como cadena decimal: un egreso en la categoría de sistema bank_fees; null si no hay comisión.

  • amountintegerobligatorio

    Valor de la transferencia en unidades mínimas de la moneda de la tienda: lo llevan las dos partes. La diferencia de cambio de un canje de monedas el libro la asienta como movimiento aparte.

  • currencystringobligatorio

    Moneda de los importes, código ISO 4217: la moneda de la tienda.

  • occurred_atstring (date-time)obligatorio

    Momento de la transferencia.

  • occurred_onstring (date)obligatorio

    Fecha contable de la transferencia, YYYY-MM-DD en la zona horaria de la tienda.

  • descriptionstring o nullobligatorio

    Descripción de la transferencia; null si no se cargó.

  • from_transaction_idintegerobligatorio

    ID del movimiento de egreso en la cuenta de origen.

  • to_transaction_idintegerobligatorio

    ID del movimiento de ingreso en la cuenta de destino.

  • fee_transaction_idinteger o nullobligatorio

    ID del movimiento de la comisión; null si no hay comisión.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

Endpoints

Obtener una transferencia entre cuentas de dinero

get/money-transfers/{money_transfer}

Scope: finance:read

Parámetros

Ruta

  • money_transferintegerobligatorio

    ID de la transferencia: el transfer_id de sus partes en el libro de movimientos de dinero.

Respuestas

200Éxito

Encabezados

  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve MoneyTransfer

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/money-transfers/{money_transfer}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "version": 0,
  "from_account_id": 0,
  "to_account_id": 0,
  "from_amount": "string",
  "from_currency": "string",
  "to_amount": "string",
  "to_currency": "string",
  "fee": "string",
  "amount": 0,
  "currency": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "description": "string",
  "from_transaction_id": 0,
  "to_transaction_id": 0,
  "fee_transaction_id": 0,
  "created_at": "2026-01-15T12:00:00Z"
}

Editar la transferencia entera en su lugar: cuentas, importes, comisión, fecha y descripción

patch/money-transfers/{money_transfer}

Scope: finance:write

Parámetros

Ruta

  • money_transferintegerobligatorio

    ID de la transferencia: el transfer_id de sus partes en el libro de movimientos de dinero.

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringobligatorio

    ETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.

    Ejemplo:
    "7"

Cuerpo de la solicitud application/json

  • from_account_idinteger

    ID de la cuenta de dinero de la que salió el dinero.

    Mínimo:
    1
  • to_account_idinteger

    ID de la cuenta de dinero a la que entró el dinero.

    Mínimo:
    1
  • from_amountstring

    Importe que salió de from_account_id en su moneda, como cadena decimal.

    Largo máximo:
    37
  • to_amountstring o null

    Importe que entró en to_account_id en su moneda, como cadena decimal. En la misma moneda es igual a from_amount: la diferencia es la comisión fee.

    Largo máximo:
    37
  • feestring o null

    Comisión de la transferencia en la moneda de la cuenta de origen, como cadena decimal: un egreso en la categoría de sistema bank_fees; null si no hay comisión.

    Largo máximo:
    37
  • occurred_onstring (date)

    Fecha contable de la transferencia, YYYY-MM-DD en la zona horaria de la tienda.

  • occurred_atstring (date-time)

    Momento de la transferencia.

  • descriptionstring o null

    Descripción de la transferencia; null si no se cargó.

    Largo máximo:
    1000

Respuestas

200Éxito

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve MoneyTransfer

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

412El registro cambió después de leerlo: la versión de If-Match no es la actual

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

428La solicitud necesita If-Match con el ETag del registro

application/problem+json

Devuelve Problem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X PATCH "https://api.saleya.app/v1/money-transfers/{money_transfer}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Cuerpo de la solicitud — body.json
{
  "from_account_id": 1,
  "to_account_id": 1,
  "from_amount": "string",
  "to_amount": "string",
  "fee": "string",
  "occurred_on": "2026-01-15",
  "occurred_at": "2026-01-15T12:00:00Z",
  "description": "string"
}
Ejemplo de respuesta · 200
{
  "id": 0,
  "version": 0,
  "from_account_id": 0,
  "to_account_id": 0,
  "from_amount": "string",
  "from_currency": "string",
  "to_amount": "string",
  "to_currency": "string",
  "fee": "string",
  "amount": 0,
  "currency": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "description": "string",
  "from_transaction_id": 0,
  "to_transaction_id": 0,
  "fee_transaction_id": 0,
  "created_at": "2026-01-15T12:00:00Z"
}

Borrar una transferencia con todas sus partes

delete/money-transfers/{money_transfer}

Scope: finance:write

Parámetros

Ruta

  • money_transferintegerobligatorio

    ID de la transferencia: el transfer_id de sus partes en el libro de movimientos de dinero.

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringobligatorio

    ETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.

    Ejemplo:
    "7"

Respuestas

204Éxito

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true

Sin cuerpo

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

412El registro cambió después de leerlo: la versión de If-Match no es la actual

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

428La solicitud necesita If-Match con el ETag del registro

application/problem+json

Devuelve Problem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X DELETE "https://api.saleya.app/v1/money-transfers/{money_transfer}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'

Transferir dinero entre cuentas, con comisión o sin ella

post/money-transfers

Scope: finance:write

Parámetros

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Cuerpo de la solicitud application/json

  • from_account_idintegerobligatorio

    ID de la cuenta de dinero de la que salió el dinero.

    Mínimo:
    1
  • to_account_idintegerobligatorio

    ID de la cuenta de dinero a la que entró el dinero.

    Mínimo:
    1
  • from_amountstringobligatorio

    Importe que salió de from_account_id en su moneda, como cadena decimal.

    Largo máximo:
    37
  • to_amountstring o null

    Importe que entró en to_account_id en su moneda, como cadena decimal. En la misma moneda es igual a from_amount: la diferencia es la comisión fee.

    Largo máximo:
    37
  • feestring o null

    Comisión de la transferencia en la moneda de la cuenta de origen, como cadena decimal: un egreso en la categoría de sistema bank_fees; null si no hay comisión.

    Largo máximo:
    37
  • occurred_onstring (date)

    Fecha contable de la transferencia, YYYY-MM-DD en la zona horaria de la tienda.

  • occurred_atstring (date-time)

    Momento de la transferencia.

  • descriptionstring o null

    Descripción de la transferencia; null si no se cargó.

    Largo máximo:
    1000

Respuestas

201Creado

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"
  • Locationstring (uri)obligatorio

    Dirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.

application/json

Devuelve MoneyTransfer

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/money-transfers" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Cuerpo de la solicitud — body.json
{
  "from_account_id": 1,
  "to_account_id": 1,
  "from_amount": "string",
  "to_amount": "string",
  "fee": "string",
  "occurred_on": "2026-01-15",
  "occurred_at": "2026-01-15T12:00:00Z",
  "description": "string"
}
Ejemplo de respuesta · 201
{
  "id": 0,
  "version": 0,
  "from_account_id": 0,
  "to_account_id": 0,
  "from_amount": "string",
  "from_currency": "string",
  "to_amount": "string",
  "to_currency": "string",
  "fee": "string",
  "amount": 0,
  "currency": "string",
  "occurred_at": "2026-01-15T12:00:00Z",
  "occurred_on": "2026-01-15",
  "description": "string",
  "from_transaction_id": 0,
  "to_transaction_id": 0,
  "fee_transaction_id": 0,
  "created_at": "2026-01-15T12:00:00Z"
}