Skip to main content

Enviar callback de consentimento

Enviar callback de consentimento

Request Body required
  • clientCallbackId string required
  • state string required
  • tokenId string nullable
  • code string nullable
  • error string nullable
  • errorDescription string nullable
Responses


Schema
  • paymentId string required

    Identificador do pagamento

  • externalId string required

    Identificador externo do pagamento

  • parentPaymentId string

    Identificador do pagamento pai para o qual foi solicitado o estorno

  • value number required

    Valor do pedido

  • sandboxMode boolean required

    Indica se este pagamento é ou não para ambiente sandbox

  • status string required

    Possible values: [created, requested, denied, settled, cancelled, refunded]

    Status do pedido

  • returnUrl string required

    URL necessária para redirecionar o usuário final de volta à loja do comerciante ao fim do fluxo de pagamento

  • callbackProtocol string required

    Possible values: [HTTP, NATS]

    Protocolo utilizado para notificação de alterações de status do pagamento

  • callbackAddress string required

    URL para notificação de alterações de status do pagamento

  • paymentUrl string

    URL para o White Label

  • creditor object required
  • name string required

    Nome do recebedor

  • document string required

    Documento do recebedor

  • pixKeyToReceive string

    Chave PIX do recebedor para recebimento do pagamento

  • debtor object required
  • name string required

    Nome do pagador

  • organization object required
  • id string

    Identificador da organização

  • name string

    Nome da organização

  • logoUrl string

    Logo da organização

  • termsOfServiceUrl string

    URL com os termos de serviço da organização

  • pixMessage string

    Informações adicionais sobre um pagamento, a serem enviadas ao destinatário

  • createdAt string required

    Data de criação

  • updatedAt string required

    Data da última atualização

  • deletedAt string

    Data de exclusão

  • theme object
  • faviconUrl string required

    Default value: https://fcamara.com/wp-content/uploads/2022/12/cropped-favicon-1-32x32.png

    URL do favicon do cliente

  • logoUrl string required

    Default value: https://fcamara.nacao.digital/wp-content/uploads/2022/08/logo-1.png

    Logo do cliente

  • primaryColor string required

    Default value: #4b4fa1

    Cor primária do cliente

  • secondaryColor string required

    Default value: #eb6744

    Cor secundária do cliente

Loading...