Transaction Response

If successful, the response returns the transaction ID under the parameter uid as well as information about the transaction. This transaction ID can be used as parameter of the Get Transaction by UID request to retrieve the transaction information at any time. It can also be used as parameter of the Get Landing Info request to get the checkout information of some payment methods and design your own checkout page.

📘
Checkout page
The object form contains the URL of the checkout page. You must redirect your users to this URL after sending the request for them to get the payment instructions.

Transaction Response Fields

Field	Description
`uid`	The ID of the transaction created.
`type`	Will always have a value of `payment`.
`status`	The current status of the transaction. Will be PENDING after creation.
`message`	The value that was put in the `description` field of the request. If omitted, the value will be `null`.
`trackingId`	The tracking ID used in the request. If omitted, the value will be `null`.
`amount`	The amount of the transaction.
`currency`	The currency of the shop used.
`description`	The value that was put in the `description` field of the request. If omitted, the value will be `null`.
`createdAt`	The timestamp of the creation date of the transaction.
`updatedAt`	The time of the last status change of the transaction.
`pspTransactionId`	The transaction ID on the side of the PSP.
`isValidPaymentMethod`	Depreciated. Will always have a value of `null`.
`customer`	The object containing the customer information. Any unrequired field left out of the request will have a value of `null`.
`form`	The object that contains the URL of the checkout that must be used to redirect the user.
`paymentMethod`	An object containing the name, ID and type of payment method used to create the transaction.
`billing`	An object containing the `amount` and `currency` sent in the request.
`conversionInfo`	Depreciated. Will always have a value of `null`.

Response Example

{
  "uid": "105433d8-74584-40b1-8f0e-3d543bbc0648",
  "type": "payment",
  "status": "PENDING",
  "message": null,
  "trackingId": "10010000A100028",
  "amount": 1768,
  "currency": "USD",
  "description": "Payment Test",
  "createdAt": "2023-03-13T12:16:17.6633918Z",
  "updatedAt": "2023-03-13T12:16:17.6633918Z",
  "pspTransactionId": "840480",
  "isValidPaymentMethod": null,
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "",
    "country": "BR",
    "city": "Sao Paulo",
    "zip": "",
    "address": "R. Sao Joaquim, 596",
    "phone": "5511999999999",
    "deviceId": "",
    "ip": "81.47.160.151",
    "personalId": "00113562600",
    "uniqueCustomerIdentifier": null,
    "accountCreationDate": null,
    "accountCreationCountry": null,
    "email": "[email protected]"
  },
  "form": {
    "action": "https://api.gateway.payretailers.com/v2/public/transactions/gateway/105433d8-74584-40b1-8f0e-3d543bbc0648",
    "method": "GET"
  },
  "paymentMethod": {
    "id": "20421d39-5236-5421-9d0a-a9453279c98f",
    "name": "TEST",
    "type": "Online"
  },
  "billing": {
    "currency": "BRL",
    "amount": 10000
  },
  "conversionInfo": null
}