@cosmosapp/pay_sdkServeur

Le Client

L'objet Client : les gestionnaires qu'il expose, ses options de constructeur et les structures auto-actives qu'il renvoie.

Presque tout ce que vous faites passe par une seule instance de Client. Elle regroupe l'API en un gestionnaire par ressource et renvoie des objets qui peuvent agir sur eux-mêmes.

import { Client } from '@cosmosapp/pay_sdk';
const client = new Client({ apiKey: process.env.COSMOS_PAY_API_KEY });

Un seul client expose chaque ressource via son propre gestionnaire.

GestionnaireRessourceMéthodes clés
client.paymentIntentsIntentions Stellar SEP-7createTx · createPay · fetch · list · update · delete · validate
client.webhooksPoints de terminaison + livraisons + écouteur d'événementscreate · list · fetch · update · delete · rotateSecret · ping · fetchDeliveries · redeliver · on(...) · process · createHandler · middleware
client.productsProduits / prixcreate · list · fetch · update · delete
client.customersClientscreate · list · fetch · update · delete
client.analyticsMétriques en lecture seulesummary · balances · apiLogs · webhookLogs
client.healthLiveness / readinessliveness · readiness

Les objets renvoyés sont des « structures »

Les méthodes des gestionnaires renvoient des instances riches (PaymentIntent, WebhookEndpoint, Product, Customer) qui peuvent agir sur elles-mêmes et exposent des accesseurs typés, par ex. intent.isPay, intent.assetLabel, await intent.validate(txHash), await endpoint.disable(). Appelez .toJSON() pour la charge utile brute.

Références

  • Customer : un enregistrement client, éventuellement enrichi de statistiques de paiement sur la chaîne.
  • PaymentIntent : une intention de paiement Stellar SEP-7
  • Product : un produit / prix que le consommateur peut facturer.
  • WebhookEndpoint : un point de terminaison webhook enregistré
  • Client : le point d'entrée principal du SDK, un client unique et atomique qui expose chaque ressource via son propre gestionnaire (une conception atomique à client unique).
  • PrivatePayment: A private payment, from client.privatePayments: an amount in XLM whose value is hidden on-chain
  • Usdt0Transfer: A USDT0 transfer from Stellar to an EVM network through LayerZero, from client.usdt0

Sur cette page