Buscar Transação

Consultar Transação

curl --request GET \
  --url https://gateway.3xpay.co/transaction/v2/{transactionId}/find \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>'

{
  "status": "SUCCESS",
  "transaction": {
    "transaction_id": "001d9bf0-d736-4882-8ed0-e332bb118009",
    "external_id": "G50403083329447uMFsSb",
    "status": "PROCESSED",
    "typeTransaction": "OUT",
    "total": "579.06",
    "created_at": "2025-04-03T11:33:31.104Z",
    "updated_at": "2025-04-03T11:33:36.244Z",
    "e2e_id": "E05491616202504031133322540c3ea4",
    "error_message": "<string>",
    "payment_code": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/44c5e891-9afc-4c7f-9954-5fbdc69600eb5204000053039865802BR59043XIP6013BELOHORIZONTE61083401102162070503***63047DE4",
    "payer": {
      "name": "3X INSTITUICAO DE PAGAMENTO LTDA",
      "document": "36.010.822/0001-09",
      "bankCode": "400",
      "bankName": "COOP CREDITAG",
      "bankIspb": "5491616"
    },
    "receiver": {
      "name": "GABRIEL DIBACHTI INACIO DA SILVA",
      "document": "022.***.***-40",
      "bankCode": "077",
      "bankName": "BANCO INTER",
      "bankIspb": "00416968"
    }
  }
}

GET

transaction

{transactionId}

find

Consultar Transação

curl --request GET \
  --url https://gateway.3xpay.co/transaction/v2/{transactionId}/find \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>'

{
  "status": "SUCCESS",
  "transaction": {
    "transaction_id": "001d9bf0-d736-4882-8ed0-e332bb118009",
    "external_id": "G50403083329447uMFsSb",
    "status": "PROCESSED",
    "typeTransaction": "OUT",
    "total": "579.06",
    "created_at": "2025-04-03T11:33:31.104Z",
    "updated_at": "2025-04-03T11:33:36.244Z",
    "e2e_id": "E05491616202504031133322540c3ea4",
    "error_message": "<string>",
    "payment_code": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/44c5e891-9afc-4c7f-9954-5fbdc69600eb5204000053039865802BR59043XIP6013BELOHORIZONTE61083401102162070503***63047DE4",
    "payer": {
      "name": "3X INSTITUICAO DE PAGAMENTO LTDA",
      "document": "36.010.822/0001-09",
      "bankCode": "400",
      "bankName": "COOP CREDITAG",
      "bankIspb": "5491616"
    },
    "receiver": {
      "name": "GABRIEL DIBACHTI INACIO DA SILVA",
      "document": "022.***.***-40",
      "bankCode": "077",
      "bankName": "BANCO INTER",
      "bankIspb": "00416968"
    }
  }
}

Authorizations

api_key

string

header

required

api_secret

string

header

required

Path Parameters

transactionId

string

required

Response

200 - application/json

Detalhes da transação

status

string

Status da resposta

Example:

"SUCCESS"

transaction

object

Show child attributes

transaction.transaction_id

string

Identificador único da transação

Example:

"001d9bf0-d736-4882-8ed0-e332bb118009"

transaction.external_id

string

Identificador externo da transação

Example:

"G50403083329447uMFsSb"

transaction.status

string

Status da transação

Example:

"PROCESSED"

transaction.typeTransaction

string

Tipo da transação

Example:

"OUT"

transaction.total

string

Valor total da transação

Example:

"579.06"

transaction.created_at

string<date-time>

Data de criação da transação

Example:

"2025-04-03T11:33:31.104Z"

transaction.updated_at

string<date-time>

Data da última atualização da transação

Example:

"2025-04-03T11:33:36.244Z"

transaction.e2e_id

string

Identificador end-to-end da transação PIX

Example:

"E05491616202504031133322540c3ea4"

transaction.error_message

string | null

Mensagem de erro, se houver

transaction.payment_code

string | null

Código de pagamento PIX

Example:

"00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/44c5e891-9afc-4c7f-9954-5fbdc69600eb5204000053039865802BR59043XIP6013BELOHORIZONTE61083401102162070503***63047DE4"

transaction.payer

object

Show child attributes

transaction.payer.name

string

Nome do pagador

Example:

"3X INSTITUICAO DE PAGAMENTO LTDA"

transaction.payer.document

string

Documento do pagador (CPF/CNPJ)

Example:

"36.010.822/0001-09"

transaction.payer.bankCode

string

Código do banco do pagador

Example:

"400"

transaction.payer.bankName

string

Nome do banco do pagador

Example:

"COOP CREDITAG"

transaction.payer.bankIspb

string

Código ISPB do banco do pagador

Example:

"5491616"

transaction.receiver

object

Show child attributes

transaction.receiver.name

string

Nome do recebedor

Example:

"GABRIEL DIBACHTI INACIO DA SILVA"

transaction.receiver.document

string

Documento do recebedor (CPF/CNPJ)

Example:

"022.***.***-40"

transaction.receiver.bankCode

string

Código do banco do recebedor

Example:

"077"

transaction.receiver.bankName

string

Nome do banco do recebedor

Example:

"BANCO INTER"

transaction.receiver.bankIspb

string

Código ISPB do banco do recebedor

Example:

"00416968"

Devolução Saldo da conta

⌘I

API Documentation

Sub-accounts API

Endpoint Examples

Webhooks

Authorizations

Path Parameters

Response