Criar uma Transação PIX

curl --location --request POST '/v1/transactions' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount": 2000, "payment_method":"pix", "billing":{ "name":"LUCILUCI DOS SANTOS", "address":{ "country":"br", "street":"Rua Jesuíno Anastácio Pereira", "street_number":"665", "state":"SC", "city":"CAMBORIÚ", "neighborhood":"Santa Regina" } }, "customer":{ "name":"LUCILUCI DOS SANTOS", "email":"luci@mail.com", "type":"individual", "country":"br", "documents":[ { "type":"cnpj", "number":"" } ], "external_id":"1" }, "shipping":{ "name":"LUCILUCI DOS SANTOS", "fee":"0", "address":{ "street":"Rua Jesuíno Anastácio Pereira", "street_number":"665", "zipcode":"88345572", "country":"br", "state":"SC", "city":"CAMBORIÚ" } } }'

{ "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", "pix_qr_code":"00020126890014BR.GOV.BCB.PIX2567api-pix.bancobs2.com.br/spi/v2/74943a5b-0978-41a9-8839-6edc03abb51552040000530398654041.005802BR5911Gateway6014Belo Horizonte61083038040362070503***63048605", "pix_expiration_date":"2025-04-02 13:43:00", "pix_additional_fields":{ "pix_id":"abdb5ba36e90498ea4d56067e695d75b" }, "reference_key": null, "session": null, "local_time": null, "payment_method": "pix", "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

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)

payment_method

string

requerido

Método de pagamento da transaçã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.

customer

object

requerido

Obrigatório com o antifraude habilitado. Define os dados do comprador, como nome, email, telefone e data de nascimento

name

string

requerido

Nome

string

requerido

E-mail

type

string

requerido

Tipo

country

string

requerido

País

documents

array [object {2}]

requerido

Documentos

external_id

string

requerido

ID Externo

shipping

object

requerido

Transporte

name

string

requerido

Nome

fee

string

requerido

Taxa

address

object

requerido

Endereço

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 da transação 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

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

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

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