Criar uma transação

Para fazer uma cobrança você deve usar a rota /transactions para criar a sua transação, que pode ser feita por Cartão de crédito, PIX ou Boleto.

No caso de Cartão de crédito é possível utilizar um card_id ou todos os dados do cartão diretamente. A segunda opção é a mais indicada, por fatores de segurança.

curl --location --request POST '/v1/transactions' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount": 300, "async": false, "capture": true, "installments": 1, "descriptor": "Your Descriptor", "payment_method": "credit_card", "card": { "card_number": "5502091556851234", "card_holder_name": "Luke Skywalker", "card_expiration_date": "0333", "card_cvv": "111" }, "billing": { "name": "Luke S.", "address": { "country": "br", "street": "Rua 12 de Outubro", "street_number": "220", "zipcode": "16520970", "state": "SP", "city": "Bacuriti", "neighborhood": "Centro" } }, "items": [ { "external_id": "5550134", "title": "Sabonete de Luxo", "unit_price": 10000, "quantity": 1, "tangible": true }, { "external_id": "5550134", "title": "Sabonete de Luxo", "unit_price": 10000, "quantity": 1, "tangible": false } ] }'

{ "id": 23, "ip_address": "127.0.0.1", "tid": null, "amount": 15090, "capture_amount": 15090, "paid_amount": null, "ref_id": "5992873329", "status": "processing", "created_at": "2022-02-02T18:05:37.000000Z", "updated_at": "2022-02-02T18:05:37.000000Z", "card": { "card_id": 409902444, "card_holder_name": "Customer Name", "created_at": "2022-02-02T17:47:10.000000Z", "updated_at": "2022-02-02T18:05:36.000000Z", "card_first_digits": "0000", "card_last_digits": "0009", "brand": "0" }, "pix_qr_code": null, "pix_expiration_date": null, "pix_additional_fields": null, "installments": 1, "reference_key": null, "session": null, "local_time": null, "payment_method": "credit_card", "customer": { "id": 4642, "external_id": "1234f", "name": "James Bond", "type": "individual", "country": "br", "email": "james@bond.com", "birthday": null, "phone_numbers": [ "+5511987654321" ], "created_at": "2022-02-02T18:05:37.000000Z", "updated_at": "2022-02-02T18:05:37.000000Z", "documents": [ { "id": 4563, "type": "cpf", "number": "47009616000" } ] }, "billing": { "id": 4418, "name": "Nome do pagador", "created_at": "2022-02-02T18:05:37.000000Z", "updated_at": "2022-02-02T18:05:37.000000Z", "address": { "street": "Alamenda Rio Negro", "street_number": "500", "zipcode": "06454000", "country": "br", "state": "sp", "city": "barueri", "neighborhood": "Alphaville", "complementary": null } }, "items": [ { "id": 8912, "external_id": "123", "title": "Nome do Produto 1", "unit_price": 1590, "quantity": 1, "tangible": 1, "category": null, "venue": null, "date": null, "created_at": "2022-02-02T18:05:37.000000Z", "updated_at": "2022-02-02T18:05:37.000000Z" } ], "metadata": null }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

amount

integer

requerido

Valor da Transação. Deve ser passado em centavos Ex: R$ 190,90 = 19090. mínimo 1 real (100)

async

boolean

requerido

Utilize false caso queira manter o processamento síncrono de uma transação. Ou seja, a resposta da transação é recebida na hora.

capture

boolean

requerido

Após a autorização de uma transação, você pode escolher se irá capturar ou adiar a captura do valor. Caso opte por postergar a captura, atribua o valor false

installments

integer

requerido

Somente se payment_method for credit_card. Número de parcelas da transação, sendo mínimo: 1 e Máximo: 21.

descriptor

string

requerido

Descrição que aparecerá na fatura depois do nome de sua empresa. Máximo de 13 caracteres, somente letras sem espaço.

payment_method

string

requerido

Método de pagamento da transação. Aceita: (credit_card, pix ou boleto)

card

object

requerido

Ao realizar uma transação, retornamos o card_id do cartão, para que nas próximas transações ele possa ser utilizado como forma de identificar os dados de pagamento.

card_number

string

requerido

Número do cartão

card_holder_name

string

requerido

Nome do portador do cartão

card_expiration_date

string

requerido

Data de validade do cartão no formato MMYY

card_cvv

string

requerido

Código verificador do cartão

billing

object

requerido

Endereço de cobrança do cliente. O campo billing é obrigatório para todas as transações de cartão de crédito com antifraude habilitado.

name

string

requerido

Nome do cliente

address

object

requerido

Detalhamento do Endereço do cliente.

items

array [object {5}]

requerido

Itens

external_id

string

requerido

ID Externo

title

string

requerido

Título do Item

unit_price

integer

requerido

Preço Unitário

quantity

integer

requerido

Quantidade

tangible

boolean

requerido

Tangível

Examples

Respostas

🟢200Criar uma Transação

application/json

Body

integer

requerido

ID da Transação

ip_address

string

requerido

Endereço de IP

tid

null

requerido

amount

integer

requerido

Valor da Transação. Valor apresentado em centavos Ex: R$ 190,90 = 19090.

capture_amount

integer

requerido

Valor capturado

paid_amount

null

requerido

Valor pago

ref_id

string

requerido

ID de Referencia

status

string

requerido

Status da transação

created_at

string

requerido

Data de criação

updated_at

string

requerido

Ultima atualização

card

object

requerido

Cartão

card_id

integer

requerido

ID do Cartão

card_holder_name

string

requerido

Nome do portador

created_at

string

requerido

Data de cadastro

updated_at

string

requerido

Última atualização

card_first_digits

string

requerido

Primeiros dígitos do cartão

card_last_digits

string

requerido

Últimos dígitos do cartão

brand

string

requerido

Bandeira

pix_qr_code

null

requerido

QR Code para pix

pix_expiration_date

null

requerido

Data de expiração do QRCode

pix_additional_fields

null

requerido

Campos adicionais do Pix

installments

integer

requerido

Parcelas

reference_key

null

requerido

Chave de referencia

session

null

requerido

Sessão

local_time

null

requerido

Horário local

payment_method

string

requerido

Método de pagamento

customer

object

requerido

Cliente

integer

requerido

ID do Cliente

external_id

string

requerido

ID Externo

name

string

requerido

Nome

type

string

requerido

Tipo

country

string

requerido

País

string

requerido

E-mail

birthday

null

requerido

Aniversário

phone_numbers

array[string]

requerido

Número de telefone

created_at

string

requerido

Data de cadastro

updated_at

string

requerido

Última atualização

documents

array [object {3}]

requerido

Documentos

billing

object

requerido

Endereço de cobrança do cliente. O campo billing é obrigatório para todas as transações de cartão de crédito com antifraude habilitado.

integer

requerido

ID do endereço de cobrança

name

string

requerido

Nome do Cliente

created_at

string

requerido

Data de cadastro

updated_at

string

requerido

Última atualização

address

object

requerido

Endereço

items

array [object {11}]

requerido

Itens

integer

opcional

ID do Item

external_id

string

opcional

ID Externo

title

string

opcional

Título do produto

unit_price

integer

opcional

Preço unitário

quantity

integer

opcional

Quantidade

tangible

integer

opcional

Tangível

Criar uma Transação

Criar uma transação#

Requisição

Respostas

Criar uma transação