🔛Criação de Transações: Cartão de Crédito, PIX e Cripto

Este endpoint é versátil e permite a criação de transações utilizando diferentes métodos de pagamento, como cartão de crédito, PIX e criptomoedas.

Ao especificar o método de pagamento adequado, você pode processar pagamentos diretamente ou criar transações pendentes para captura posterior.

Cria uma transação, de crédito pix ou cripto

post

https://gws.bemfacil.com.brhttps://gws-hml.bemfacil.com.br

/transaction

Endpoint para criar uma transação Por padrão cria para cartão de crédito, mas pode criar transação pix ou cripto, usando o campo payment_method com os valores credit,pix,cripto Pode ser criada já fazendo o pagamento caso seja uma transação de crédito(se passados os dados do cartão) Também pode ser criada uma transação de crédito sem capturar o valor, ou seja, não efetivar o pagamento (campo capture=false) Nesse caso pode ser feita a captura manualmente pelo endpoint /capture ou efetivado o pagamento no envpoint /pay

Body

application/json

documentstringOptional

CPF do pagador

namestringOptional

Nome do pagador

titlestringOptional

Título da compra

descriptionstringOptional

Descritivo da compra

amountnumberOptional

Valor do pagamento em centavos

emailstringOptional

Email do pagador

payment_methodstringOptional

Meio de pagamento [credit|pix|crypto]

installmentsnumberOptional

Número de parcelas do pagamento

capturebooleanOptional

Flag indicando se o pagamento deve ser capturado automaticamente

limit_datestringOptional

Data limite para o pagamento

Responses

201

Pagamento realizado com sucesso

400

Requisição inválida

500

Erro interno do servidor

post

/transaction

HTTPcURLJavaScriptPython

POST /transaction HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "document": "40404040411",
  "amount": 10,
  "payment_method": "credit",
  "installments": 1
}

cpf examplepix examplecnpj examplecreate and pay

No content

Respostas Esperadas:

• 201 Created: Indica que a transação foi criada com sucesso e o pagamento foi processado ou está pendente para captura, dependendo do valor do campo capture.

• 400 Bad Request: A requisição é inválida. Isso geralmente ocorre devido à falta de informações necessárias ou ao formato incorreto dos dados enviados.

• 500 Internal Server Error: Um erro ocorreu no servidor. Isso pode ser temporário; tente novamente mais tarde. Se o problema persistir, entre em contato com o suporte técnico.

Notas de Segurança:

• Assegure-se de que todas as informações do pagador sejam tratadas com confidencialidade e em conformidade com as regulamentações de proteção dedados aplicáveis.

• Todas as transações devem ser feitas em um ambiente seguro e criptografado para proteger as informações financeiras e pessoais do usuário.

---

Faz o pagamento de uma transação de crédito criada

put

https://gws.bemfacil.com.brhttps://gws-hml.bemfacil.com.br

/transaction/pay/{id}

Endpoint para pagar uma transação passando dos dados do cartão ou token Se a transação foi criada com os dados do cartão não é necessário passar novamente Se a transação foi /criada sem captura (campo capture=false), esse endpoint confirma e efetiva o pagamento

Path parameters

idstringRequired

Identificador único da transação

Body

application/json

Responses

200

Pagamento realizado com sucesso

No content

400

Requisição inválida

500

Erro interno do servidor

put

/transaction/pay/{id}

HTTPcURLJavaScriptPython

PUT /transaction/pay/{id} HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

created with cardcreated without card

No content

Faz a captura de uma transação de crédito criada

put

https://gws.bemfacil.com.brhttps://gws-hml.bemfacil.com.br

/transaction/capture/{id}

Endpoint para capturar uma transação passando dos dados do cartão (sem efetivar) Para usar esse endpoint a transação deve ter sido criada sem captura (campo capture=false) Nesse endpoint será apenas capturado o valor sem efetivar a transação, após isso é necessário ainda chamar o endpoint /pay

Path parameters

idstringRequired

Identificador único da transação

Body

application/json

Responses

200

Pagamento capturado com sucesso

No content

400

Requisição inválida

500

Erro interno do servidor

put

/transaction/capture/{id}

HTTPcURLJavaScriptPython

PUT /transaction/capture/{id} HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "card": {
    "type": "text",
    "number": "text",
    "expiry_date": "text",
    "security_code": "text",
    "owner": {
      "first_name": "text",
      "last_name": "text",
      "phone": "text",
      "email": "text",
      "address": {
        "postal-code": "text",
        "street": "text",
        "number": "text",
        "district": "text",
        "city": "text",
        "state": "text"
      }
    }
  }
}

No content

Consulta uma transação pelo id

get

https://gws.bemfacil.com.brhttps://gws-hml.bemfacil.com.br

/transaction/{id}

Endpoint para retornar as informações da transação dessa forma é possível consultar o status e possíveis atualizações

Path parameters

idstringRequired

Identificador único da transação

get

/transaction/{id}

HTTPcURLJavaScriptPython

GET /transaction/{id} HTTP/1.1
Host: gws.bemfacil.com.br
Accept: */*