@cosmosapp/pay_sdkServidor

O Client

O objeto Client: os gerenciadores que ele expõe, suas opções de construtor e as estruturas autoatuantes que ele retorna.

Quase tudo o que você faz passa por uma única instância de Client. Ela agrupa a API em um gerenciador por recurso e retorna objetos que podem agir sobre si mesmos.

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

Um único cliente expõe cada recurso por meio do seu próprio gerenciador.

GerenciadorRecursoMétodos principais
client.paymentIntentsIntenções SEP-7 da StellarcreateTx · createPay · fetch · list · update · delete · validate
client.webhooksEndpoints + entregas + listener de eventoscreate · list · fetch · update · delete · rotateSecret · ping · fetchDeliveries · redeliver · on(...) · process · createHandler · middleware
client.productsProdutos / preçoscreate · list · fetch · update · delete
client.customersClientescreate · list · fetch · update · delete
client.analyticsMétricas somente leiturasummary · balances · apiLogs · webhookLogs
client.healthLiveness / readinessliveness · readiness

Os objetos retornados são "estruturas"

Os métodos dos gerenciadores retornam instâncias ricas (PaymentIntent, WebhookEndpoint, Product, Customer) que podem agir sobre si mesmas e expõem acessadores tipados, por exemplo, intent.isPay, intent.assetLabel, await intent.validate(txHash), await endpoint.disable(). Chame .toJSON() para obter o payload bruto.

Referências

  • Customer: Um registro de cliente, opcionalmente enriquecido com estatísticas de pagamento on-chain.
  • PaymentIntent: Uma intenção de pagamento SEP-7 da Stellar
  • Product: Um produto / preço pelo qual o consumidor pode cobrar.
  • WebhookEndpoint: Um endpoint de webhook registrado
  • Client: O ponto de entrada principal do SDK, um único cliente atômico que expõe cada recurso por meio do seu próprio gerenciador (um design atômico de cliente único).
  • 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

Nesta página