Sign in

v1

latestOpenAPI 3.1.02026-07-24740156.0 KB

Criar cobrança

Esse endpoint permite criar cobranças de Cartão de Crédito, Pix e Boleto Bancário.

post/v2/payment

Request body

PaymentMethodstring required

Informar o código do método de pagamento. Clique aqui para conferir os métodos disponíveis.

IsSandboxboolean required

Identifica se a transação vai ser realizada em ambiente sandbox ou não.

Applicationstring required

Use para identificar suas aplicações nas transações.

CallbackUrlstring

URL de notificações de mudança de status da transação.

IpAddressstring

Use para enviar o IP (v4 ou v6) do cliente. Ex: 200.200.200.200

Vendorstring

Nome do vendedor que será vinculado a essa transação. Ex: João da Silva

Referencestring

Use para identificar suas transações. Ex: REFERENCIA_TESTE_V1

VisitorIDstring

Use para informar o identificador gerado pelo script antifraude. (Esse atributo pode ser utilizado quando o método de pagamento for Cartão de Crédito - PaymentMethod = 2)

ShouldUseAntiFraudboolean

Use para identificar se a transação deve ou não passar pela análise do antifraude. No seu painel deve estar sinalizado que a análise será "por transação". Ao enviar como falso, você está assumindo o risco de chargeback. (Esse atributo pode ser utilizado quando o método de pagamento for Cartão de Crédito - PaymentMethod = 2) Para utilizar o script antifraude em seu site clique aqui.

Response

200

HasErrorboolean

Example response

{
  "ResponseDetail": {
    "IdTransaction": 1049946,
    "Token": "36d8f360-6019-49f4-9cf4-3d8d198817e8",
    "Description": "O seu pagamento foi autorizado pela operadora do cartão de crédito.",
    "Tid": "020006495642",
    "AuthorizationCode": "205340",
    "Status": 3,
    "Message": "Pagamento Autorizado",
    "CreditCard": {
      "CardNumber": "402400******3191",
      "Brand": 1,
      "Installments": 1
    }
  }
}
All 74 operations