API Documentation

Schemas

PaymentRequest

Nome	Tipo	Descrição	Required
amount	number	Valor do pagamento em centavos, sem vírgula e ponto.	Sim
order_id	string	Seu Número do Pedido.	Não
online_id	string	Seu Número de Identificação da Compra.	Não
payment	Payment	Informações do pagamento, modelo de autorização e fluxo a ser executado.	Sim
customer	Customer	Informações relacionados ao cliente vinculado ao pagamento.	Sim
metadata	Metadata	O parâmetro metadata permite insirir "Chave e Valor" como informações adicionais a uma transação.	Não

Payment

Nome	Tipo	Descrição	Required	Default
type	string	Tipo de pagamento (ex: credit / debit).	Sim
installments	number	Número de parcelas do pagamento.	Sim
capture	boolean	Indica se o pagamento deve ser autorizado no momento da criação. Valores possíveis: Autorização - true, Pré-Autorização - false.	Não	false
has_interest	boolean	Indica se o pagamento possui juros.	Não	false
authenticate	boolean	Indica se o pagamento terá dupla autenticação junto ao Banco Emissor do cartão com 3DS. Valores possíveis: Fluxo Normal - False ou Autenticação 3DS - true	Não	false
softdescriptor	string	Texto exibido na Fatura do cartão do Comprador.	Não
currency_code	string	Moeda na qual o pagamento será processado. Valores possíveis: `BRL`	Não	BRL
card	Card	Informações do Cartão do Comprador.	Não

Card

Nome	Tipo	Descrição	Required
holder	string	Nome do comprador impresso no cartão. Obrigatório caso o pagamento não seja tokenizado.	Não
number	string	Número do cartão do comprador. Obrigatório caso o pagamento não seja tokenizado.	Não
expire_month	string	Mês de expiração do cartão com dois dígitos. Obrigatório caso o pagamento não seja tokenizado.	Não
expire_year	string	Ano de expiração do cartão com quatro dígitos. Obrigatório caso o pagamento não seja tokenizado.	Não
brand	string	Bandeira do cartão. Valores possíveis: Visa, Mastercard, Amex, Elo, Hipercard.	Sim
cvc	string	Código de segurança impresso no cartão. Obrigatório caso o pagamento não seja tokenizado.	Não
vault	string	Identificador do cartão no cofre. Obrigatório caso o pagamento seja tokenizado.	Não

Customer

Nome	Tipo	Descrição	Required
name	string	Nome do comprador.	Sim
document	string	Número do documento (CPF) do comprador.	Sim
email	string	E-mail do comprador.	Não
phone	string	Telefone do comprador.	Não
birthDate	string	Data de nascimento do comprador.	Não
ip	string	Endereço IP do dispositivo do comprador.	Não
billing_address	string	Endereço de cobrança.	Não
shipping_address	string	Endereço de envio.	Não

Address

Nome	Tipo	Descrição	Required
street	string	Nome da rua.	Não
number	string	Número do endereço.	Não
district	string	Bairro.	Não
complement	string	Complemento do endereço.	Não
city	string	Cidade.	Não
state	string	Estado abreviado. Ex: SP	Não
zipcode	string	CEP sem pontuações. Ex: 01451000	Não
country	string	País. Ex: Brasil	Não

Metadata

Nome	Tipo	Descrição	Required	Default
key	string	Chave de metadados	Não
value	string	Valor dos metadados	Não

{ "status": 3, "returnCode": "0", "returnMessage": "Sucesso", "message": "SUCESSO", "paymentId": "010000003811041456460000064215020000000000", "authorizationCode": "007019", "orderNumber": "6183f4ac7ad8d", "onlineId": "HROJSF", "type": "credit", "delayed_split": false, "installments": 1, "brand": "mastercard", "amount": 3990, "fees": 260, "liquid": 3730, "acquirer": "adiq", "metadata": [ { "metadata_key": "key", "metadata_value": "value" }, { "metadata_key": "key2", "metadata_value": "value2" } ], "createdAt": "2021-11-04 11:56:50", "expireAt": "2021-11-11 11:56:50", "first4Digits": "5201", "last4Digits": "5011", "nsu": "61a7d95711f57", "customer": { "name": "Comprador Teste", "document": "99999999999", "email": "example@test.com", "phone": "11999999999", "birthDate": "1969-12-31", "billingAddress": { "street": "Rua teste", "number": "1", "district": "Bairro teste", "complement": "Complemento teste", "zipcode": "99999999", "city": "São Paulo", "state": "SP", "country": "BRA" } } }

sales

API Documentation

Schemas

PaymentRequest

Payment

Card

Customer

Address

Metadata

Requisição

Respostas

sales

API Documentation#

Schemas#

PaymentRequest#

Payment#

Card#

Customer#

Address#

Metadata#

Requisição

Respostas

API Documentation

Schemas

PaymentRequest

Payment

Card

Customer

Address

Metadata