Integración

Uno de los principales puntos de interacción con la Anchor Platform es notificar a la Plataforma sobre eventos relacionados con transacciones.

En general, querrás proporcionar actualizaciones para los siguientes eventos.

• Tu negocio requiere que el usuario envíe información KYC para procesar una transacción
• Tu negocio actualizó las cantidades de entrada/salida/tarifa para una transacción
• Tu negocio está listo para recibir fondos del usuario
• Tu negocio ha recibido fondos del usuario
• Tu negocio ha enviado fondos al usuario
• Tu negocio ha procesado un reembolso para la transacción del usuario
• Tu negocio experimentó un error inesperado

Esto se realiza haciendo peticiones JSON-RPC al endpoint de la API de la Plataforma. Las solicitudes JSON-RPC te permiten actualizar el estado de la transacción. Para cambiar la transacción a un estado específico, es necesario hacer una solicitud JSON-RPC correspondiente y pasar los datos requeridos por el método RPC.

La API JSON-RPC de la Anchor Platform está diseñada para notificar a la plataforma sobre cambios en el estado de la transacción. Por ello, la API se llamará cada vez que un usuario o el anchor realicen una acción que progrese el estado de la transacción en el flujo.

La comunicación desde la Anchor Platform sobre actualizaciones de transacciones, actualizaciones de clientes y creación de cotizaciones se maneja a través del servicio de eventos. Esta es una función opcional que debe configurarse por separado de la integración SEP-6. Para más información, consulta [Manejo de eventos][event-handling].

Puedes obtener más información sobre el flujo y estados de la transacción en el documento del protocolo SEP-6.

Callbacks

La Anchor Platform confía en el servidor del negocio para proveer y almacenar información sobre clientes y cotizaciones.

Información del Cliente

La Anchor Platform no almacena información del cliente. En su lugar, reenvía todas las solicitudes SEP-12 del cliente al servidor del negocio. El servidor del negocio es responsable de almacenar y gestionar esta información. Por lo tanto, tu servidor del negocio debe implementar las [APIs de cliente][customer-callback] para manejar actualizaciones KYC.

Cotizaciones y Tarifas

Para soportar el exchange de activos no equivalentes, la Anchor Platform expone una API compatible con SEP-38 para proporcionar cotizaciones para el exchange. La API de cotización se usa para proveer al usuario con la cantidad esperada del activo que recibirá a cambio del activo que envía. La API de cotización también se usa para proveer al usuario con las tarifas esperadas para la transacción. Por lo tanto, tu servidor del negocio debe implementar la [API de tasas][rate-callback] para proporcionar cotizaciones a la Anchor Platform.

Asegurando la API de la Plataforma

advertencia

Por defecto, los endpoints de la API de la Plataforma, como GET /transactions y GET /transactions/:id, no están protegidos y son accesibles por cualquier persona que tenga acceso al servidor, incluidas las billeteras.

información

Se recomienda que el servidor de la Plataforma sea accesible solo desde la red privada. Sin embargo, es posible que desees agregar una capa adicional de protección asegurando la API.

Uso de Clave API

Para habilitar la autenticación con clave de API, modifica tu archivo dev.env:

bash

# dev.env
PLATFORM_SERVER_AUTH_TYPE=api_key
# Will be used as API key
SECRET_PLATFORM_API_AUTH_SECRET="your API key that business server will use"

Una vez habilitado, todas las solicitudes deben incluir un encabezado válido X-Api-Key, configurado con la clave de API establecida.

Uso de JWT

Para habilitar la autenticación JWT, modifica tu archivo dev.env:

bash

# dev.env
PLATFORM_SERVER_AUTH_TYPE=jwt
# Will be used to sign the JWT token
SECRET_PLATFORM_API_AUTH_SECRET="your secret that business server will use"

Anchor Platform utiliza el algoritmo HMAC SHA-256 (HS256) para firmar los tokens JWT. Asegúrate de que SECRET_PLATFORM_API_AUTH_SECRET tenga al menos 32 caracteres de longitud por motivos de seguridad.

Una vez habilitado, todas las solicitudes deben incluir un encabezado Authorization válido con el formato Bearer <JWT token>.

Realizando Solicitudes JSON-RPC

Antes de hacer solicitudes JSON-RPC, primero vamos a crear una plantilla para hacer una solicitud a la Anchor Platform.

bash

# call-json-rpc.sh
#!/usr/bin/env bash

curl localhost:8085 \
    -X POST \
    -H 'Content-Type: application/json' \
    --data "@$1"

Este pequeño script hará una solicitud JSON-RPC a la Anchor Platform alojada en el puerto predeterminado (8085). Los datos de transacción JSON almacenados en el archivo proporcionado se utilizarán como cuerpo (las solicitudes deben ser un array).

Solicitud JSON-RPC

El objeto Request debe contener los siguientes atributos:

ATRIBUTOTIPO DE DATO

DESCRIPCIÓN

jsonrpccadena

Una cadena que especifica la versión del protocolo JSON-RPC. MUST be exactly "2.0"

métodocadena

Una cadena que contiene el nombre del método a invocar. La lista de métodos disponibles que puedes ver en [Métodos JSON-RPC][json-rpc-methods]

paramsobjeto

A Structured value that holds the parameter values, corresponding to method call, to be used during the invocation of the method

idcadena

Un identificador establecido por el cliente. The Server will reply with the same value in the Response object

consejo

Es posible proporcionar múltiples actualizaciones en una sola solicitud JSON-RPC (colocando múltiples objetos de solicitud JSON-RPC). Cuando se realiza una actualización de esta manera, todas las actualizaciones se realizarán de forma secuencial.

Lo más importante, cada solicitud JSON-RPC no es atómica. Si una actualización falla, todas las actualizaciones anteriores SE APLICARÁN y todas las actualizaciones posteriores SE PROCESARÁN y APLICARÁN también.

Respuesta JSON-RPC

La respuesta se expresa como un único objeto JSON, con los siguientes atributos:

ATRIBUTOTIPO DE DATO

DESCRIPCIÓN

jsonrpccadena

Una cadena que especifica la versión del protocolo JSON-RPC. Está configurado en "2.0"

resultadoobjeto

Un valor estructurado que contiene los detalles de la transacción actualizada

idcadena

Un identificador enviado por el cliente

errorobjeto

Un valor estructurado que contiene los detalles del error

Mostrar atributos secundarios

idcadena

Id único de la transacción para la cual ocurrió un error

códigonúmero

Un número que indica el tipo de error que ocurrió. Por favor, consulta una lista de códigos de error a continuación

mensajecadena

Una cadena que proporciona una breve descripción del error

datoscadena

Un valor primitivo o estructurado que contiene información adicional sobre el error

Códigos de Error

Código de error	Significado
-32600	El JSON enviado no es un objeto Request válido
-32601	El método no existe / no está disponible
-32602	Invalid method parameter(s)
-32603	Error interno de JSON-RPC

consejo

También haremos referencia a una variable $transaction_id. Esta es una identificación de la transacción que se devuelve desde el Anchor Platform en una solicitud de inicio de retirada de fondos o depósito. Puedes obtener el ID de la transacción conectando la billetera de prueba a tu instancia local de Anchor Platform.

Actualizando Transacción de Depósito (Exchange) Via JSON-RPC

El diagrama del flujo de depósito SEP-6 define secuencias/reglas para la transición de estados de la transacción y un conjunto de métodos JSON-RPC que se deben llamar para cambiar ese estado. No puedes definir el estado que deseas establecer para una transacción específica en tus solicitudes. Cada método JSON-RPC define las estructuras de datos que espera en la solicitud. Si la solicitud no contiene atributos requeridos, la Anchor Platform devolverá un error y no cambiará el estado de la transacción.

El flujo de exchange de depósito es igual que el flujo de depósito, excepto que las cantidades no necesitarán ser recalculadas al solicitar fondos offchain, si el usuario proporcionó una cotización firme del anchor.

consejo

Los estados en verde son obligatorios y definen el camino más corto.

Los estados en amarillo son opcionales y se pueden omitir.

Los estados en rojo significan que la transacción está en un estado de error o ha caducado.

Verificar Información KYC

Aunque la Anchor Platform no requiere que un cliente tenga su información KYC recopilada antes de iniciar un depósito, tu negocio puede querer recopilar esta información antes de que el cliente realice una transferencia. Al escuchar eventos de transacciones creadas, o mediante la consulta al endpoint [GET /transactions][get-transactions], puedes determinar si una transacción requiere que el cliente actualice su información. Los campos SEP-9 requeridos pueden comunicarse al usuario devolviendo un estado NEEDS_INFO con los campos requeridos en el atributo fields.

Después de que el usuario haya enviado su información KYC, llama al método JSON-RPC notify_customer_info_updated para actualizar el estado de la transacción. Además, llama a este método cada vez que el estado SEP-12 para un cliente cambie, como cuando la información del cliente está siendo validada y el estado cambia de NEEDS_INFO a PROCESSING. Esto asegura que cualquier cliente configurado con una URL de callback sea notificado del último estado del cliente, permitiendo que el cliente solicite al usuario actualizar su información.

JSON

// notify-customer-info-updated.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_customer_info_updated",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Customer info updated",
      "customer_id": "45f8884d-d6e1-477f-a680-503179263359",
      "customer_type": "sep6-deposit" // or sep6-withdrawal
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh notify-customer-info-updated.json

Listo para Recibir Fondos

Después de que el usuario haya enviado su información KYC, el anchor puede notificar a la Plataforma que está listo para recibir fondos. El anchor debe usar el RPC request_offchain_funds para proporcionar las cantidades finales al usuario. Para hacerlo, realiza la siguiente solicitud JSON-RPC.

JSON

// request-offchain-funds.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "request_offchain_funds",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Request offchain funds",
      "amount_in": {
        "amount": 10,
        "asset": "iso4217:USD"
      },
      "amount_out": {
        "amount": 9,
        "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
      },
      "amount_fee": {
        "amount": 1,
        "asset": "iso4217:USD"
      },
      "amount_expected": {
        "amount": 10
      },
      "instructions": {
        "organization.bank_number": {
          "value": "123456789",
          "description": "US Bank routing number"
        },
        "organization.bank_account_number": {
          "value": "123456789",
          "description": "US Bank account number"
        }
      }
    }
  }
]

• amount_in es la cantidad que el usuario debe enviar al negocio.
• amount_out es la cantidad que el usuario recibirá.
• amount_fee es el monto total de las tarifas cobradas por el negocio.
• asset es parte del campo amount_x y está en formato SEP-38. En este ejemplo, está configurado como USD, asumiendo que el usuario hizo una transferencia bancaria al sistema usando USD.
• instructions es el conjunto de campos estándar SEP-9 que el usuario debe usar para enviar fondos al negocio. En este ejemplo, el usuario debe enviar fondos a la cuenta bancaria con el número de ruta 123456789 y número de cuenta 123456789.

La información sobre las cantidades (entrada/salida/tarifa) es requerida si quieres mover la transacción al estado pending_user_transfer_start.

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh request-offchain-funds.json

advertencia

Para depósitos de exchange con una cotización firme (la solicitud está asociada con un quote_id), no deben proporcionarse cantidades.

Fondos Recibidos

Si se recibieron fondos offchain, deberás proporcionar información actualizada de la transacción.

JSON

// offchain-funds-received.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_offchain_funds_received",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Offchain funds received",
      "funds_received_at": "2023-07-04T12:34:56Z",
      "external_transaction_id": "7...9",
      "amount_in": {
        "amount": 10
      },
      "amount_out": {
        "amount": 9
      },
      "amount_fee": {
        "amount": 1
      },
      "amount_expected": {
        "amount": 10
      }
    }
  }
]

• funds_received_at es la fecha y hora de recepción de fondos.
• external_transaction_id es el ID de la transacción en la red externa.

Los campos de cantidad son opcionales. Si se omiten, se usarán los valores previos a esta solicitud.

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh offchain-funds-received.json

Esperando fondos del usuario

En el mundo real, el proceso de confirmación de la transferencia puede tomar tiempo. En tales casos, las transacciones deberían establecerse en un nuevo estado que indique que se ha recibido la confirmación de la transferencia, pero que aún no se han recibido los fondos.

JSON

// offchain-funds-sent.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_offchain_funds_sent",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Offchain funds sent",
      "funds_received_at": "2023-07-04T12:34:56Z",
      "external_transaction_id": "7...9"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh offchain-funds-sent.json

Enviando fondos onchain

Luego, envía una transacción en la red Stellar para cumplir con el depósito del usuario. Después de que la transacción Stellar haya sido enviada, es necesario enviar la solicitud JSON-RPC notify_onchain_funds_sent para notificar al usuario que los fondos se enviaron correctamente.

JSON

// onchain-funds-sent.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_onchain_funds_sent",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Onchain funds sent",
      "stellar_transaction_id": "7...9"
    }
  }
]

• stellar_transaction_id es el ID de la transacción en la red Stellar de la transferencia.

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh onchain-funds-sent.json

Después de esta solicitud JSON-RPC, la transacción se transferirá al estado completed.

Enviando pago vía servicio de custodia

La Anchor Platform ofrece la posibilidad de enviar un pago a través de servicios de custodia, como Fireblocks. Para hacer un pago a través de un servicio de custodia, realiza la siguiente solicitud JSON-RPC.

JSON

// do-stellar-payment.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "do_stellar_payment",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Custody payment started"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh do-stellar-payment.json

Después de procesar exitosamente el pago en un servicio de custodia, la Anchor Platform hará automáticamente la solicitud JSON-RPC notify_onchain_funds_sent y el estado de la transacción cambiará a completed.

advertencia

La cuenta del usuario puede no estar lista para recibir fondos. Puedes verificar que la cuenta haya establecido una trustline. De lo contrario, puedes establecer el estado de la transacción a pending_trust para indicar que el anchor está esperando que el usuario establezca la trustline.

Si la integración de custodia está habilitada, la Anchor Platform hará esta validación automáticamente por ti.

Esperando Trust

Este estado debe establecerse si un pago requiere una trustline de activo que el usuario no ha configurado. Hay dos maneras en que la transacción puede pasar al estado pending_trust. La primera es procesar un pago a través de un servicio de custodia en caso de que se detecte que la trustline no está configurada. La segunda es cuando el negocio mismo detecta que falta la trustline y quiere notificar al usuario que debe configurarla. Para mover la transacción al estado pending_trust, realiza la siguiente solicitud JSON-RPC.

JSON

// request-trust.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "request_trust",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Asset trustine not configured"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh request-trust.json

información

El pago vía servicio de custodia comprueba periódicamente si la trustline fue configurada. Si fue configurada, enviará automáticamente el pago al servicio de custodia y cambiará el estado de la transacción a pending_stellar.

Trust Set

Este estado debe establecerse si el negocio ha detectado que la trustline fue o no configurada por el usuario.

JSON

// trust-set.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_trust_set",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Asset trustine set",
      "success": "true"
    }
  }
]

• El flag success que define si la trustline fue o no configurada por el usuario

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh trust-set.json

información

Dependiendo del flag success, el estado de la transacción cambiará a pending_stellar si la trustline fue configurada, o a pending_anchor si no lo fue.

Reembolso Enviado

A veces, los fondos deben ser devueltos al usuario (reembolso). Puedes reembolsar la suma total (reembolso completo) o hacer un conjunto de reembolsos parciales a la source_account usando el refund_memo y refund_memo_type asociados con la transacción si están presentes. Además, si el usuario envió más dinero del esperado, puedes reembolsar una parte de la suma al usuario y enviar el resto como fondos onchain.

JSON

// refund-sent.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_refund_sent",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Refund sent",
      "refund": {
        "id": "1c186184-09ee-486c-82a6-aa7a0ab1119c",
        "amount": {
          "amount": 10,
          "asset": "iso4217:USD"
        },
        "amount_fee": {
          "amount": 1,
          "asset": "iso4217:USD"
        }
      }
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh refund-sent.json

información

Si la suma de los reembolsos es menor que amount_in, el estado de la transacción se establecerá en pending_anchor. Solo si la suma de los reembolsos es igual a amount_in, el estado de la transacción se establecerá en refunded.

Reembolso Pendiente

Esto es similar a Reembolso Enviado, pero maneja el caso cuando un reembolso ha sido enviado a una red externa pero aún no está confirmado. El estado de la transacción se establece en pending_external. Este es el estado que se establece al esperar que Bitcoin u otra red criptográfica externa complete una transacción, o al esperar una transferencia bancaria.

Error en la Transacción

Si encuentras un error irrecuperable al procesar la transacción, es necesario establecer el estado de la transacción a error. Puedes usar el campo mensaje para describir los detalles del error.

JSON

// transaction-error.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_transaction_error",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Error occurred"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh transaction-error.json

consejo

Si un usuario ha hecho una transferencia, debes hacer una recuperación de transacción, y luego puedes reintentar el procesamiento de la transacción o iniciar un reembolso.

Transacción Caducada

Tu negocio puede querer expirar las transacciones abandonadas por el usuario después de algún tiempo. Es buena práctica limpiar las transacciones inactivas en el estado incomplete. Para hacerlo, realiza la siguiente solicitud JSON-RPC para expirar una transacción.

JSON

// transaction-expired.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_transaction_expired",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Transaction expired"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh transaction-expired.json

consejo

Este método JSON-RPC no puede usarse después de que el usuario haya realizado una transferencia.

Recuperación de la Transacción

El estado de la transacción puede cambiar de error/expired a pending_anchor. Después de la recuperación, puedes reembolsar los activos recibidos o continuar con el procesamiento de la transacción. Para recuperar una transacción, realiza la siguiente solicitud JSON-RPC.

JSON

// transaction-recovery.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_transaction_recovery",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Transaction recovered"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh transaction-recovery.json

Actualizando Transacción de Retirada (Exchange) Via JSON-RPC

El diagrama del flujo de retirada SEP-6 define la secuencia/reglas para la transición de estados de la transacción. No puedes definir el estado que deseas establecer para una transacción específica en tus solicitudes. Cada método JSON-RPC define las estructuras de datos que espera en la solicitud. Si la solicitud no contiene atributos requeridos, la Anchor Platform devolverá un error y no cambiará el estado de la transacción.

El flujo de exchange de retirada es igual que el flujo de retirada, excepto que las cantidades no necesitarán ser recalculadas al solicitar fondos onchain, si el usuario proporcionó una cotización firme del anchor.

consejo

Los estados en verde son obligatorios y definen el camino más corto.

Los estados en amarillo son opcionales y se pueden omitir.

Los estados en rojo significan que la transacción está en un estado de error o ha caducado.

Una vez que el flujo de retirada ha finalizado, implementar la retirada es sencillo. Algunas partes del flujo son similares y pueden reutilizarse.

El punto de partida tanto para la retirada como para el depósito es el mismo.

Listo para Recibir Fondos

De manera similar al depósito, el paso después de recopilar KYC es notificar al usuario que el anchor está listo para recibir fondos. Sin embargo, como tu servicio recibirá transacciones a través de la red Stellar, la solicitud RPC será diferente. El anchor debe usar el RPC request_onchain_funds para proporcionar las cantidades finales al usuario. Para hacerlo, realiza la siguiente solicitud JSON-RPC.

JSON

// request-onchain-funds.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "request_onchain_funds",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Request onchain funds",
      "amount_in": {
        "amount": 10,
        "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
      },
      "amount_out": {
        "amount": 9,
        "asset": "iso4217:USD"
      },
      "amount_fee": {
        "amount": 1,
        "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
      },
      "amount_expected": {
        "amount": 10
      },
      "destination_account": "GD...G",
      "memo": "12345",
      "memo_type": "id"
    }
  }
]

• amount_in es la cantidad que el usuario debe enviar al negocio.
• amount_out es la cantidad que el usuario recibirá.
• amount_fee es el monto total de las tarifas cobradas por el negocio.
• asset es parte del campo amount_x y está en formato SEP-38. En este ejemplo, está configurado como USD, asumiendo que el usuario hizo una transferencia bancaria al sistema usando USD.
• memo es el memo que el usuario debe usar al enviar sus fondos onchain al anchor.
• memo_type es el tipo de memo que el usuario debe usar al enviar sus fondos onchain al anchor.
• destination_account es la cuenta a la que el usuario debe enviar los fondos.

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh request-onchain-funds.json

advertencia

Para retiros de exchange con una cotización firme (la solicitud está asociada con un quote_id), no se deben proporcionar cantidades.

consejo

Establecer memo, memo_type y destination_account es opcional.

Si la integración con un custodio externo está habilitada, la Anchor Platform puede generar memo, memo_type y destination_address si se elige el tipo de generador de información de depósito correspondiente. Además, puedes proporcionar memo y memo_type en la solicitud como se muestra arriba. Ten en cuenta que el memo debe ser único, esto ayuda a asociar transacciones Stellar con transacciones SEP.

Si tu negocio administra los activos, la Anchor Platform puede generar memos por ti. Cuando el estado cambia a pending_user_transfer_start, la Anchor Platform establece automáticamente el memo y memo_type (solo si no están incluidos en la solicitud).

nota

La cuenta Stellar que se usará para recibir fondos debe configurarse.

Fondos Recibidos

Si se recibieron fondos onchain, necesitas proporcionar las cantidades y cambiar el estado de la transacción a pending_anchor.

JSON

// onchain-funds-received.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_onchain_funds_received",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Onchain funds received",
      "stellar_transaction_id": "7...9",
      "amount_in": {
        "amount": 10
      },
      "amount_out": {
        "amount": 9
      },
      "amount_fee": {
        "amount": 1
      }
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh onchain-funds-received.json

consejo

Este método será llamado automáticamente por el servidor de custodia si la integración de custodia está habilitada.

Cantidad Actualizada

Si se recibieron fondos onchain, pero por alguna razón el amount_in difiere del especificado en el flujo interactivo (amount_expected), puedes actualizar amount_out y amount_fee para que correspondan al amount_in real. El estado de la transacción en este caso no cambiará y será igual a pending_anchor.

JSON

// amounts-updated.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_amounts_updated",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Amounts updated",
      "amount_out": {
        "amount": 9
      },
      "amount_fee": {
        "amount": 1
      }
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh amounts-updated.json

nota

Solo amount_out y amount_fee pueden actualizarse usando esta solicitud JSON-RPC, y no necesitas especificar los activos de las cantidades.

Fondos Offchain Disponibles

Puedes mover el estado de la transacción a pending_user_transfer_complete si se enviaron fondos offchain y si está listo para que el usuario o destinatario los recoja.

JSON

// offchain-funds-available.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_offchain_funds_available",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Offchain funds available",
      "external_transaction_id": "a...c"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh offchain-funds-available.json

Fondos Offchain Pendientes

Otra opción es mover el estado de la transacción a pending_external. Este estado significa que el pago ha sido enviado a una red externa, pero aún no está confirmado.

JSON

// offchain-funds-pending.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_offchain_funds_pending",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Offchain funds pending",
      "external_transaction_id": "a...c"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh offchain-funds-pending.json

Fondos Offchain Enviados

Para completar la transacción y cambiar su estado a completed, debes hacer la solicitud JSON-RPC notify_offchain_funds_sent.

JSON

// offchain-funds-sent.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_offchain_funds_sent",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Offchain funds sent",
      "funds_sent_at": "2023-07-04T12:34:56Z",
      "external_transaction_id": "a...c"
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh offchain-funds-sent.json

Reembolso Enviado

La lógica de reembolso funciona de la misma manera que para el flujo de depósito. Para más detalles, consulta Reembolso Enviado del flujo de depósito.

Enviando Reembolso Vía Servicio de Custodia

La integración con un servicio de custodia te permite hacer un reembolso a través de un servicio como Fireblocks.

JSON

// do-stellar-refund.json
[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "do_stellar_refund",
    "params": {
      "transaction_id": "<transaction_id>",
      "message": "Do stellar refund",
      "refund": {
        "amount": {
          "amount": 9,
          "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
        },
        "amount_fee": {
          "amount": 1,
          "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
        }
      }
    }
  }
]

Para procesar esto, necesitas ejecutar:

bash

./call-json-rpc.sh do-stellar-refund.json

nota

De manera similar al flujo de depósito, puedes hacer un reembolso completo o un conjunto de reembolsos parciales. La transacción permanecerá en estado pending_anchor mientras la suma de reembolsos sea menor que amount_in. Si la suma de reembolsos es igual a amount_in, la Anchor Platform cambiará automáticamente el estado de la transacción a refunded.

Error en la Transacción

Funciona de la misma manera que para el flujo de depósito. Para más detalles, consulta Error en la Transacción del flujo de depósito.

Transacción Caducada

Funciona de la misma manera que para el flujo de depósito. Para más detalles, consulta Transacción Caducada del flujo de depósito.

Recuperación de la Transacción

Funciona de la misma manera que para el flujo de depósito. Para más detalles, consulta Recuperación de la Transacción del flujo de depósito.

Seguimiento de Transacciones Stellar

Usar el Payment Observer te permite delegar este paso a la Anchor Platform. Para habilitar el Payment Observer, usa la bandera --stellar-observer en la sección de comandos del archivo de composición.

El Payment Observer rastreará todas las transacciones enviadas a la cuenta de distribución. Cuando se detecte la transacción con el memo esperado en la red, el estado cambiará automáticamente a pending_anchor y se emitirá el evento (si se usa Kafka).

Para actualizar los estados de la transacción, el observador hace las solicitudes JSON-RPC correspondientes a la plataforma. Debería usar la siguiente URL.

bash

# dev.env
PLATFORM_API_BASE_URL=http://platform-server:8085

advertencia

El Payment Observer no validará los montos. Es tu responsabilidad verificar que el monto enviado por el usuario sea correcto.

información

Si ya tienes un sistema que monitorea pagos, asegúrate de que la lógica del sistema iguale la descripción a continuación:

Primero, espera a que la transacción se incluya en el ledger (usando un SDK). Esta transacción debe tener el memo esperado y la dirección de destino (cuenta de distribución). Una vez que se haya detectado y verificado esta transacción, notifica al usuario que los fondos han sido recibidos utilizando la solicitud JSON-RPC notify_onchain_funds_received.

consejo

El servicio de custodia de Fireblocks rastreará automáticamente las transacciones y notificará al usuario que los fondos han sido recibidos. Consulta la documentación del servicio de custodia de Fireblocks para más detalles.