v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Landing Info

Use this call to get all the data you need to design your own checkout page.

get/public/transactions/landing-info/{TransactionID}

Path parameters

TransactionIDstring required

The ID of the transaction generated with the <a href="https://payretailers.readme.io/reference/create-transaction">POST Transaction</a> method.

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

OR
OR
OR
OR
OR

Example response

{
  "amount": 100,
  "currency": "BRL",
  "expirationDate": "2023-03-20T12:21:07.807",
  "references": [
    {
      "id": 1,
      "type": "MAIN",
      "value": "d73512b1-3921-4a7e-3823-d54e634rwqb6"
    }
  ],
  "instructions": [
    {
      "id": 1,
      "type": "NORMAL",
      "value": "1) Abra o app do seu banco"
    }
  ],
  "qrCodes": [
    {
      "id": 1,
      "type": "LINK",
      "value": "https://pr-az-pro-payin-br-9.azurewebsites.net/api/v1/public/payments/qrcode/bca0e55d-4a53-4d1c-ab95-a11111b0a6b8"
    }
  ],
  "links": [
    {
      "id": 1,
      "type": "POLICY"
    }
  ],
  "logos": [
    {
      "id": 1,
      "type": "MAIN",
      "value": "https://pr-az-pro-payin-br-9.azurewebsites.net/api/v1/Content/Public/Gateway/images/BoletoPixPayRetailers.png"
    }
  ]
}