APIs relacionadas a pagamento

Certas APIs permitem a integração com sistemas financeiros externos.

  • executeCollection() - Processa solicitações individuais de autorização e cobrança na ordem em que as solicitações foram feitas. Se você precisar processar solicitações individualmente, é possível chamar essa API para executar solicitações individuais conforme necessário. Essa API chama a saída de usuário apropriada para executar o processamento de pagamento.
  • recordCollection( ) - Registra a autorização e os valores de cobrança processados para solicitações individuais criadas pelo Sterling™ Order Management System. Isso é útil quando você deseja fazer interface com sistemas de processamento de pagamento externos em um modo em lote para processar um grupo de solicitações e, em seguida, atualizar o Sterling Order Management System com os resultados.
  • processOrderPayments() - Chama a API requestCollection() e a API executeCollection() em uma única chamada, o que permite a autorização on-line da quantia de um pedido inteira para evitar despesas desnecessárias. A API processOrderPayments() pega uma lista de métodos de pagamento no pedido.
  • executePaymentTransactions() - Processa solicitações para autorização e cobrança antes de criar ou confirmar um pedido. Várias solicitações de pagamento são autorizadas ou cobradas na ordem em que são feitas. Essa API verifica as condições de pagamento antes de chamar a saída de usuário apropriada para executar o processamento de pagamento. Se a API encontrar um erro durante a verificação, ela finalizará o processo sem chamar a saída de usuário. Se ocorrer um erro enquanto a saída de usuário estiver em processamento, a API finalizará a saída de usuário e retornará todas as transações de pagamento bem-sucedidas, incluindo a primeira transação com falha.
  • scheduleOrder() - Calcula quando os pedidos devem ser reautorizados.
  • getOrderDetails() - Retorna informações detalhadas sobre um número de pedido específico das tabelas de históricos ou transação. As informações incluem OrderLines, PriceInfo, OverallTotals, ChargeTransactionDetails, OrderStatus e outras informações relacionadas ao pedido.
  • recordExternalCharges() - Registra todas as autorizações e cobranças realizadas externamente ao Sterling Order Management System. Essa API também é usada para registrar um pagamento recebido por um sistema externo. um exemplo é uma conta do comprador que recebe pagamento após um período de tempo considerável. A API executeCollection teria notificado previamente oSterling Order Management System de que essa cobrança está sendo processada de forma assíncrona e, em seguida, a API recordExternalCharges registra a cobrança real.
  • requestCollection() API - Analisa o pedido e determina a quantia para a qual uma solicitação de autorização ou cobrança deve ser criada.
  • recordInvoiceCreation() - Registra avisos de crédito, avisos de débito ou faturas informativas com relação a um pedido. Quando um memorando de crédito ou um memorando de débito é registrado usando essa API, ele age como um acionador para o Sterling Order Management System para chamar processos de quitação para a quantia que está sendo faturada O Sterling Order Management System não faz nenhum processamento de pagamento para faturas informativas criadas por meio dessa API Essas faturas podem ser usadas para capturar solicitações da transportadora, e assim por diante, que são processadas de fato por meio de um sistema externo, mas registradas com relação ao pedido para propósitos de visibilidade.
  • createAccessToken - Gera um token de acesso aleatório e exclusivo. Isso é usado para autenticar chamadas para o sistema de validação de pagamento
  • manageChargeTransactionRequest e getChargeTransactionRequestList - Essas APIs gerenciam o processo de autorização para os identificadores de solicitação de transação de cobrança associados a um pedido. A API getChargeTransactionRequestList recupera as solicitações de transação de cobrança para autorização. A API manageChargeTransactionRequest também reconfigura a data de expiração da autorização no pedido para sysdate que, por sua vez, permite que a API requestCollection determine a quantia para a qual a solicitação de autorização ou cobrança deve ser criada. Cada chamada de API pode processar simultaneamente várias solicitações de transação de cobrança para um pedido.
  • computeRefundPayments() - Processa reembolsos com relação a várias ordens de vendas. A API computeRefundPayments copia métodos de pagamento das ordens de vendas no pedido de devolução, deriva novos métodos de pagamento conforme necessário, agrega ordens de vendas e devoluções em branco vinculadas, limita reembolsos por ordem de vendas e suporta a transferência de fundos para pedidos de troca.
  • capturePayment() - captura as informações do método de pagamento de um pedido. Dependendo do tipo de pagamento incluído, essa API executa diferentes ações. Por exemplo, alguns tipos de pagamento não requerem processamento, alguns requerem processamento baseado na quantia disponível e alguns podem requerer suporte para autorizações de zero dólar em vez de autorização completa.

Para obter mais informações sobre essas APIs e os eventos gerados por elas, consulte o IBM Sterling® Order Management: Javadoc.