Get Transaction by Tracking

Changed on

Use this call to get all of the details of one of your transactions.

get/transactions/byTracking/{TrackingID}

Request

  • Base URL
    https://api-sandbox.payretailers.com/payments/v2
  • URL
    https://api-sandbox.payretailers.com/payments/v2/transactions/byTracking/{TrackingID}
  • Auth
    HTTP basic

Path parameters

TrackingIDstring required

The trackingId of the transaction.

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Response

200

uidstring
typestring
statusstring
messageunknown
trackingIdunknown
amountinteger
currencystring
descriptionstring
createdAtstring
updatedAtstring
pspTransactionIdstring
isValidPaymentMethodunknown

Example response

{
  "uid": "1da75378-bb77-49a7-aba1-d85d5a84b263",
  "type": "payment",
  "status": "PENDING",
  "amount": 176,
  "currency": "USD",
  "description": "test",
  "createdAt": "2022-08-04T13:10:27.733",
  "updatedAt": "2022-08-04T13:10:27.733",
  "pspTransactionId": "7973461",
  "customer": {
    "firstName": "test",
    "lastName": "test",
    "country": "BR",
    "city": "test",
    "address": "test",
    "phone": "5555654987654",
    "ip": "173.244.55.100",
    "personalId": "16838201771",
    "email": "test@gmail.com"
  },
  "form": {
    "action": "https://api.gateway.payretailers.com/v2/public/transactions/gateway/1da75378-bb77-49a7-aba1-d85d5a84b263",
    "method": "GET"
  },
  "paymentMethod": {
    "id": "519e8120-0b38-4510-8954-3b9005b6d639",
    "name": "PIX"
  },
  "billing": {
    "currency": "BRL",
    "amount": 1000
  }
}

Changes