v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Transaction by Tracking

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

get/{TrackingID}

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

{"stackTrail":"paths:/{TrackingID}:get:responses:200:content:application/json:schema:properties:message","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/{TrackingID}:get:responses:200:content:application/json:schema:properties:trackingId","oasType":"schema","type":"unknown"}

amountinteger

currencystring

descriptionstring

createdAtstring

updatedAtstring

pspTransactionIdstring

{"stackTrail":"paths:/{TrackingID}:get:responses:200:content:application/json:schema:properties:isValidPaymentMethod","oasType":"schema","type":"unknown"}

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
  }
}