--- updatedAt: 2026-06-09T10:09:56.000Z agentTools: projectIndex: https://www.payretailers.dev/llms.txt --- # Get Landing Info Use this call to get all the data you need to design your own checkout page. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "transaction", "version": "3.3" }, "servers": [ { "url": "https://api-sandbox.payretailers.com/payments/v2" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/public/transactions/landing-info/{TransactionID}": { "get": { "summary": "Get Landing Info", "description": "Use this call to get all the data you need to design your own checkout page.", "operationId": "get-landing-info", "parameters": [ { "name": "TransactionID", "in": "path", "description": "The ID of the transaction generated with the POST Transaction method.", "schema": { "type": "string" }, "required": true }, { "name": "Ocp-Apim-Subscription-Key", "in": "header", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Successful PIX Response": { "value": { "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" }, { "id": 2, "type": "NORMAL", "value": "2) Selecione a opção de pagamento via PIX" }, { "id": 3, "type": "NORMAL", "value": "3) Selecione a opção QR Code" }, { "id": 4, "type": "NORMAL", "value": "4) Leia o código QR com a câmera do seu celular" }, { "id": 5, "type": "NORMAL", "value": "5) Autorize o pagamento" } ], "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" }, { "id": 2, "type": "RAW", "value": "00020126350014BR.GOV.BCB.PIX0113+5511496892552041110534444654075000.005802BR5922El pequeno gran hombre6013Sao beneficio62130509pagamento630415E2 " } ], "barCodes": [], "bankInfoFields": [], "links": [ { "id": 1, "type": "POLICY", "value": null }, { "id": 2, "type": "SUCCESS", "value": "https://api.gateway.payretailers.com/v2/public/transactions/gateway/success/75f06ad5-919f-532d-asw1-60a9ab2aaab4" } ], "logos": [ { "id": 1, "type": "MAIN", "value": "https://pr-az-pro-payin-br-9.azurewebsites.net/api/v1/Content/Public/Gateway/images/BoletoPixPayRetailers.png" } ] } }, "Succesful SPEI Response": { "value": "{\n\t\"amount\": 50.00,\n\t\"currency\": \"MXN\",\n\t\"expirationDate\": \"2023-03-20T15:35:22.33\",\n\t\"references\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"MAIN\",\n\t\t\t\"value\": \"0354592\"\n\t\t}\n\t],\n\t\"instructions\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"NORMAL\",\n\t\t\t\"value\": \"1/ Registra la cuenta CLABE beneficiaria\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"NORMAL\",\n\t\t\t\"value\": \"2/ Transferencia vía SPEI: ingresa desde tu banco a transferencias/pagos a otros bancos\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 3,\n\t\t\t\"type\": \"HIGHLIGHTED\",\n\t\t\t\"value\": \"IMPORTANTE: favor de introducir correctamente la Referencia Numérica en el campo \\\"motivo/concepto de la transferencia\\\" de lo contrario los fondos no podrán ser confirmados automáticamente.\"\n\t\t}\n\t],\n\t\"qrCodes\": [],\n\t\"barCodes\": [],\n\t\"bankInfoFields\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"BANK\",\n\t\t\t\"value\": \"STP\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"ACCOUNT\",\n\t\t\t\"value\": \"646180202800000007\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 3,\n\t\t\t\"type\": \"BENEFICIARY\",\n\t\t\t\"value\": \"PRETAILERS S.A DE C.V\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 4,\n\t\t\t\"type\": \"AMOUNT_TO_PAY\",\n\t\t\t\"value\": \"$ 50,00 MXN\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 5,\n\t\t\t\"type\": \"REFERENCE\",\n\t\t\t\"value\": \"0354592\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 6,\n\t\t\t\"type\": \"EMAIL\",\n\t\t\t\"value\": \"speimx@payretailers.com\"\n\t\t}\n\t],\n\t\"links\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"POLICY\",\n\t\t\t\"value\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"SUCCESS\",\n\t\t\t\"value\": \"https://api.gateway.payretailers.com/v2/public/transactions/gateway/success/26dab5e0-7668-9785-b23b-a917e4241935\"\n\t\t}\n\t],\n\t\"logos\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"MAIN\",\n\t\t\t\"value\": \"https://api.gateway.payretailers.com/Content/Public/Shared/images/payr_logo.svg\"\n\t\t}\n\t]\n}" }, "Succesful Efecty Response": { "value": "{\n\t\"amount\": 514831.00,\n\t\"currency\": \"COP\",\n\t\"expirationDate\": \"2023-03-20T15:40:33.623\",\n\t\"references\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"MAIN\",\n\t\t\t\"value\": \"945648\"\n\t\t}\n\t],\n\t\"instructions\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"NORMAL\",\n\t\t\t\"value\": \"1/ Acérquese a su punto Efecty más cercano, cualquiera de los 7.000 puntos de atención Efecty a nivel nacional.\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"NORMAL\",\n\t\t\t\"value\": \"2/ Indicar al cajero el número de convenio 112069 y la referencia de pago / PIN : 945648\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 3,\n\t\t\t\"type\": \"NORMAL\",\n\t\t\t\"value\": \"Una vez efectuado el pago el cajero le otorgará un ticket con los detalles.\"\n\t\t}\n\t],\n\t\"qrCodes\": [],\n\t\"barCodes\": [],\n\t\"bankInfoFields\": [],\n\t\"links\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"POLICY\",\n\t\t\t\"value\": \"https://payretailers.com/docs/politica-de-cookies.pdf\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"SUCCESS\",\n\t\t\t\"value\": \"https://api.gateway.payretailers.com/v2/public/transactions/gateway/success/47c25d78-be92-58iw-b0df-6f0398a682ea\"\n\t\t}\n\t],\n\t\"logos\": [\n\t\t{\n\t\t\t\"id\": 1,\n\t\t\t\"type\": \"MAIN\",\n\t\t\t\"value\": \"https://payr-co-integration-1.azurewebsites.net/Content/Public/Gateway/images/logo.png\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 2,\n\t\t\t\"type\": \"PAYMENT_METHOD\",\n\t\t\t\"value\": \"https://payr-co-integration-1.azurewebsites.net/Content/Public/Gateway/images/logo_transfer.png\"\n\t\t}\n\t]\n}" }, "Succesful MODO Response": { "value": "{\n 'amount': 15000,\n 'currency': 'ARS',\n 'expirationDate': '2026-02-13T23:59:00Z',\n 'references': [],\n 'instructions': [\n {'id': 1,\n 'type': 'NORMAL',\n 'value': '1) Abrí la aplicación de tu banco o billetera.'\n },\n {'id': 2, 'type': 'NORMAL', \n 'value': '2) Seleccioná la opción Código QR.'\n },\n {'id': 3,\n 'type': 'NORMAL',\n 'value': '3) Escaneá el código QR con la cámara de su teléfono.'\n },\n {'id': 4, 'type': 'NORMAL', \n 'value': '4) Autorizá el pago.'\n }\n ],\n 'qrCodes': [\n {'id': 1,\n 'type': 'LINK',\n 'value': 'https://payment-checkout.payretailers.com/onlineqr/api/v1/public/payments/external/qrcode/9c014848-7f11-7fa2-aa54-ad92bb9427b0'\n },\n {'id': 2,\n 'type': 'RAW',\n 'value': '00020101021143370012com.pagos36098113071410080399020150150011307154474325204899953030325802AR5912PAGOS ONLINE6007CORDOBA6108X5901AAN62220118153A09D5-10809813163042b6a'\n }\n ],\n 'barCodes': [],\n 'bankInfoFields': [],\n 'links': [\n {'id': 1, \n 'type': 'POLICY', \n 'value': None},\n {'id': 2,\n 'type': 'SUCCESS',\n 'value': 'https://pr-az-pro-one-core-1.azurewebsites.net/v2/public/transactions/gateway/success/9c014848-7f11-7fa2-aa54-ad92bb9427b0'\n }\n ],\n 'logos': []\n}\n", "summary": "Succesful MODO Response" } }, "schema": { "oneOf": [ { "title": "Successful PIX Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 100, "default": 0 }, "currency": { "type": "string", "example": "BRL" }, "expirationDate": { "type": "string", "example": "2023-03-20T12:21:07.807" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "d73512b1-3921-4a7e-3823-d54e634rwqb6" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1) Abra o app do seu banco" } } } }, "qrCodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "LINK" }, "value": { "type": "string", "example": "https://pr-az-pro-payin-br-9.azurewebsites.net/api/v1/public/payments/qrcode/bca0e55d-4a53-4d1c-ab95-a11111b0a6b8" } } } }, "barCodes": { "type": "array" }, "bankInfoFields": { "type": "array" }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "POLICY" }, "value": {} } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://pr-az-pro-payin-br-9.azurewebsites.net/api/v1/Content/Public/Gateway/images/BoletoPixPayRetailers.png" } } } } } }, { "title": "Succesful SPEI Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 50, "default": 0 }, "currency": { "type": "string", "example": "MXN" }, "expirationDate": { "type": "string", "example": "2023-03-20T15:35:22.33" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "0354592" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1/ Registra la cuenta CLABE beneficiaria" } } } }, "qrCodes": { "type": "array" }, "barCodes": { "type": "array" }, "bankInfoFields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "BANK" }, "value": { "type": "string", "example": "STP" } } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "POLICY" }, "value": {} } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://api.gateway.payretailers.com/Content/Public/Shared/images/payr_logo.svg" } } } } } }, { "title": "Succesful Efecty Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 514831, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "expirationDate": { "type": "string", "example": "2023-03-20T15:40:33.623" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "945648" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1/ Acérquese a su punto Efecty más cercano, cualquiera de los 7.000 puntos de atención Efecty a nivel nacional." } } } }, "qrCodes": { "type": "array" }, "barCodes": { "type": "array" }, "bankInfoFields": { "type": "array" }, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "POLICY" }, "value": { "type": "string", "example": "https://payretailers.com/docs/politica-de-cookies.pdf" } } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://payr-co-integration-1.azurewebsites.net/Content/Public/Gateway/images/logo.png" } } } } } }, { "title": "Succesful PuntoRed Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 507546, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "expirationDate": { "type": "string", "example": "2023-03-20T15:47:10.907" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "2012092155" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1/ Imprime tu cupón de pago" } } } }, "qrCodes": {}, "barCodes": {}, "bankInfoFields": {}, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 0, "default": 0 }, "type": { "type": "string", "example": "PDF_LINK" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net//api/v1/public/payments/pdf/download/33258712-k92o-4314-89je-63e8cf8ceebf" } } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net/Content/Public/Gateway/images/logo.png" } } } } } }, { "title": "Succesful Moviired Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 514831, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "expirationDate": { "type": "string", "example": "2023-03-20T15:49:21.183" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "2012092156" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1/ Dirígete al punto MOVILRED mas cercano." } } } }, "qrCodes": {}, "barCodes": {}, "bankInfoFields": {}, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 0, "default": 0 }, "type": { "type": "string", "example": "PDF_LINK" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net//api/v1/public/payments/pdf/download/d1abe627-9wi2-9iq0-431e-e485e65684b7" } } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net/Content/Public/Gateway/images/logo.png" } } } } } }, { "title": "Succesful Exito Response", "type": "object", "properties": { "amount": { "type": "integer", "example": 507546, "default": 0 }, "currency": { "type": "string", "example": "COP" }, "expirationDate": { "type": "string", "example": "2023-03-20T15:53:09.86" }, "references": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "2012092157" } } } }, "instructions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "NORMAL" }, "value": { "type": "string", "example": "1/ Imprime tu cupón de pago" } } } }, "qrCodes": {}, "barCodes": {}, "bankInfoFields": {}, "links": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 0, "default": 0 }, "type": { "type": "string", "example": "PDF_LINK" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net//api/v1/public/payments/pdf/download/0575ed60-9132-84iu-iow9-a9435dea0cbd" } } } }, "logos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "string", "example": "MAIN" }, "value": { "type": "string", "example": "https://payr-co-integration-4.azurewebsites.net/Content/Public/Gateway/images/logo.png" } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Landing Info Error Response": { "value": "{\n\t\"errors\": [\n\t\t{\n\t\t\t\"errorCode\": \"PAYMENT_METHOD_NOT_ALLOWED_FOR_LANDING_INFO\",\n\t\t\t\"errorMessage\": \"Payment Method not Allowed for Landing Information\",\n\t\t\t\"reference\": null,\n\t\t\t\"externalReference\": null\n\t\t}\n\t],\n\t\"data\": null,\n\t\"status\": false,\n\t\"returnValue\": 0,\n\t\"asyncOperation\": false\n}" }, "Result": { "value": "{\n\t\"errors\": [\n\t\t{\n\t\t\t\"errorCode\": \"ENTITY_NOT_FOUND\",\n\t\t\t\"errorMessage\": \"Entidad no encontrada\",\n\t\t\t\"reference\": null,\n\t\t\t\"externalReference\": null\n\t\t}\n\t],\n\t\"data\": null,\n\t\"status\": false,\n\t\"returnValue\": 0,\n\t\"asyncOperation\": false\n}" }, "Transaction Not Finished": { "value": "{\n\t\"errors\": [\n\t\t{\n\t\t\t\"errorCode\": \"TRANSACTION_NOT_FINISHED_BY_LANDING_INFO\",\n\t\t\t\"errorMessage\": \"Transaction not finished by landing information\",\n\t\t\t\"reference\": null,\n\t\t\t\"externalReference\": null\n\t\t}\n\t],\n\t\"data\": null,\n\t\"status\": false,\n\t\"returnValue\": 0,\n\t\"asyncOperation\": false\n}" } }, "schema": { "oneOf": [ { "title": "Landing Info Error Response", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "PAYMENT_METHOD_NOT_ALLOWED_FOR_LANDING_INFO" }, "errorMessage": { "type": "string", "example": "Payment Method not Allowed for Landing Information" }, "reference": {}, "externalReference": {} } } }, "data": {}, "status": { "type": "boolean", "example": false, "default": true }, "returnValue": { "type": "integer", "example": 0, "default": 0 }, "asyncOperation": { "type": "boolean", "example": false, "default": true } } }, { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "ENTITY_NOT_FOUND" }, "errorMessage": { "type": "string", "example": "Entidad no encontrada" }, "reference": {}, "externalReference": {} } } }, "data": {}, "status": { "type": "boolean", "example": false, "default": true }, "returnValue": { "type": "integer", "example": 0, "default": 0 }, "asyncOperation": { "type": "boolean", "example": false, "default": true } } }, { "title": "Transaction Not Finished", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "TRANSACTION_NOT_FINISHED_BY_LANDING_INFO" }, "errorMessage": { "type": "string", "example": "Transaction not finished by landing information" }, "reference": {}, "externalReference": {} } } }, "data": {}, "status": { "type": "boolean", "example": false, "default": true }, "returnValue": { "type": "integer", "example": 0, "default": 0 }, "asyncOperation": { "type": "boolean", "example": false, "default": true } } } ] } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n\t\"title\": \"Unauthorized\",\n\t\"status\": 401,\n\t\"traceId\": \"00-53906d01ec2d7f44803c28e73e0777c3-5af0f714cae8a744-00\"\n}" } }, "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "https://tools.ietf.org/html/rfc7235#section-3.1" }, "title": { "type": "string", "example": "Unauthorized" }, "status": { "type": "integer", "example": 401, "default": 0 }, "traceId": { "type": "string", "example": "00-53906d01ec2d7f44803c28e73e0777c3-5af0f714cae8a744-00" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "Content-Type", "value": "application/json" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```