Get Transaction by ID

Get Transaction by ID

GET {{Environment_URL}}/vendors/v1/charges/:id

This API endpoint is used to retrieve information about a specific transaction by its ID.

Headers

Name
Value

Authorization

Bearer <token>

Path Params

Name
Type
Description
Value

id

string

Transaction Identifier

d164c35a-b151-4d85-ab49-1965dcb3ad83

Response

{
  "id": "ch_01jnp92s2ss5phncb8cc36rka1",
  "amount": 1000,
  "currency": "USD",
  "metadata": null,
  "quotation": {
    "id": "2d7b77dccf5c82541c097dabe826af665bebc088",
    "tax": {
      "iof": {
        "total": {
          "value": 19,
          "divisor": 100,
          "currency": "BRL",
          "precision": 2
        },
        "percentage": 0.38
      }
    },
    "total": {
      "withTax": {
        "value": 5035,
        "divisor": 100,
        "currency": "BRL",
        "precision": 2
      },
      "withoutTax": {
        "value": 5016,
        "divisor": 100,
        "currency": "BRL",
        "precision": 2
      },
      "withFutureTax": {
        "value": 5531,
        "divisor": 100,
        "currency": "BRL",
        "precision": 2
      },
      "withTaxesAndFees": {
        "value": 5531,
        "divisor": 100,
        "currency": "BRL",
        "precision": 2
      }
    },
    "currency": {
      "code": "USD",
      "fees": [
        {
          "name": "FEE_SUPER_VENDOR",
          "type": "absolute",
          "value": 100,
          "netValue": {
            "value": 497,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
          },
          "receiver": "SUPER_VENDOR"
        }
      ],
      "name": "Dólar Americano",
      "offer": {
        "value": 1000,
        "divisor": 100,
        "currency": "USD",
        "precision": 2
      },
      "price": {
        "withTax": {
          "value": 50347,
          "divisor": 10000,
          "currency": "BRL",
          "precision": 4
        },
        "withoutTax": {
          "value": 50157,
          "divisor": 10000,
          "currency": "BRL",
          "precision": 4
        },
        "withFutureTax": {
          "value": 55313,
          "divisor": 10000,
          "currency": "BRL",
          "precision": 4
        },
        "withTaxesAndFees": {
          "value": 55313,
          "divisor": 10000,
          "currency": "BRL",
          "precision": 4
        }
      },
      "spreads": [
        {
          "name": "SPREAD_SUPER_VENDOR",
          "type": "percentage",
          "netValue": {
            "value": 50,
            "divisor": 100,
            "currency": "BRL",
            "precision": 2
          },
          "receiver": "SUPER_VENDOR",
          "percentage": 1
        }
      ],
      "offerUSD": {
        "value": 1000,
        "divisor": 100,
        "currency": "USD",
        "precision": 2
      },
      "levelingRate": {
        "value": 49660,
        "divisor": 10000,
        "currency": "BRL",
        "precision": 4
      },
      "countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
      "commercialExchangeRate": {
        "value": 49660,
        "divisor": 10000,
        "currency": "BRL",
        "precision": 4,
        "updatedAt": "2023-08-14T20:08:25.000Z"
      }
    },
    "metadata": {
      "externalId": "vnd_01hxy854h3s4x4e5mgm1frk3aq"
    },
    "createdAt": "2025-03-06T17:47:00.900Z",
    "futureTax": {
      "ir": {
        "total": {
          "value": 0,
          "divisor": 100,
          "currency": "BRL",
          "precision": 2
        },
        "percentage": 0
      }
    }
  },
  "nature": "SERVICES_AND_OTHERS",
  "status": "SUCCEEDED",
  "createdAt": "2025-03-06T17:47:02.490Z",
  "updatedAt": "2025-03-06T17:48:04.515Z",
  "vendor": {
    "id": "vnd_01hxy854h3s4x4e5mgm1frk3aq",
    "businessType": "COMPANY",
    "businessClass": [
      "RESTAURANT"
    ],
    "name": "Dunder Mifflin Paper Company",
    "vendorResponsiblePhone": "32-266-931-6242",
    "commercialPhone": "9-807-619-2586",
    "fullNameResponsible": "Michael Scott",
    "address": {
      "city": "Lackawanna County",
      "state": "Pennsylvania",
      "street": "Slough Avenue",
      "country": "us",
      "latitude": "123",
      "longitude": "123",
      "neighborhood": "Scranton",
      "openingHours": "123"
    },
    "email": "[email protected]",
    "metadata": {
      "additionalInformation[0].field": "",
      "additionalInformation[0].value": ""
    },
    "controller": {
      
    },
    "defaultCurrency": "USD",
    "natures": [
      "SERVICES_AND_OTHERS"
    ],
    "vendorResponsible": {
      
    },
    "notificationsEmail": "[email protected]",
    "commercialEmail": "[email protected]",
    "externalAccounts": [
      
    ],
    "status": "PENDING",
    "payoutsEnabled": true,
    "settings": {
      
    },
    "createdAt": "2024-05-15T13:48:02.960Z",
    "updatedAt": "2024-12-26T12:02:30.234Z",
    "financialData": {
      "bankPath": [
        {
          "bankPath": "MATERA"
        }
      ],
      "vendorBankDetails": {
        "country": "us",
        "currency": "USD",
        "accountName": "scranton"
      },
      "metaData": [
        {
          "field": "",
          "value": ""
        }
      ]
    },
    "agentId": "22",
    "logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/dunder_mifflin_scranton/1726752613637.jpeg",
    "minimumValueForFinanceBatch": null
  },
  "account": {
    "id": "acc_01hxy8dqws0pdrmnvrg76swxkx",
    "chargesEnable": true,
    "loginEnable": true,
    "provider": "MATERA",
    "providerId": "98A84B41-BDB3-F963-F85B-41BD8FF756F4",
    "accountNumber": null,
    "bankNumber": null,
    "agencyNumber": null,
    "defaultPix": null,
    "externalAccounts": [
      
    ],
    "vendor": {
      "id": "vnd_01hxy854h3s4x4e5mgm1frk3aq",
      "name": "DUNDER MIFFLIN SCRANTON ",
      "logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/dunder_mifflin_scranton/1726752613637.jpeg",
      "commercialPhone": "+5544444444444",
      "address": {
        "city": "Lackawanna County",
        "state": "Pennsylvania",
        "street": "Slough Avenue",
        "country": "us",
        "latitude": "123",
        "longitude": "123",
        "neighborhood": "Scranton",
        "openingHours": "123"
      }
    },
    "externalId": null,
    "status": "PENDING",
    "name": "Dunder Mifflin Paper Company ",
    "logo": null,
    "address": null,
    "contact": null,
    "metadata": null,
    "type": "ADMINISTRATOR"
  },
  "creditFinancial": null,
  "debitFinancial": null,
  "fsmEvents": {
    "status": [
      {
        "to": "PENDING",
        "from": "CREATED",
        "timestamp": "2025-03-06T17:47:05.276Z",
        "transition": "charge"
      },
      {
        "to": "SUCCEEDED",
        "from": "PENDING",
        "timestamp": "2025-03-06T17:48:03.649Z",
        "transition": "success"
      }
    ]
  },
  "transaction": {
    "id": "tnx_01jnp92s6fdfb4dx36kr6yt3c5",
    "amount": 5531,
    "currency": "BRL",
    "description": null,
    "destination": null,
    "metadata": null,
    "dynamicPixCode": "00020101021226990014br.gov.bcb.pix2577pix-h.bpp.com.br/23114447/qrs1/v2/01EyXo2FczEKghhjkrA4KuHoEh9R1FKC7bqVUmTknXw520400005303986540555.315802BR5907GODINES6009SAO PAULO62070503***6304FF94",
    "createdAt": "2025-03-06T17:47:02.490Z",
    "updatedAt": "2025-03-06T17:47:02.490Z",
    "paymentDetails": {
      "payerName": "John Doe",
      "payerDocument": "71677850000177",
      "method": "DYNAMIC_PIX",
      "accountNumber": "182934824",
      "accountType": "CC",
      "bankNumber": "13203354",
      "branchNumber": "1",
      "transactionEndToEndId": "E13203354202503061747B8T6AB881E0"
    }
  },
  "paymentLink": null
}