<- Regresar a la documentación

6.8. Modelos de respuesta.

A continuación se muestra ejemplo de los modelos de respuesta de la API en formato JSON, el objeto de tipo “Paginator” se utiliza para las listas.

Tipo: Paginator

{
      "links": {
                "first": {
                   "href": "Primera pagina"
                },
               "self": {
                    "href": "Pagina actual"
                },      │        
               "next": {
                    "href": "Pagina siguiente"
                },
                "last": {
                    "href": "Ultima pagina"
                }
      },
      "meta": {
                "currentPage": 1,
                "maxPerPage": 10,
                "totalPages": 1,
                "totalResults": 2
      },
      "data": [ “Lista de datos del paginador” ],
}

Códigos de respuesta de la llamada al API

Código

Descripción

200

Correcto. Retorna JSON de tipo 'PaymentIntent'

400

Solicitud incorrecta (revisar datos del formulario)

401

Token vencido o expirado

403

Sin acceso al recurso solicitado

404

No se encontro el recurso solicitado

405

Método Http no permitido (por ejemplo solo acepta POST ó GET)

503

No tiene permiso para acceder al recurso solicitado

Nota: Si recibe un código de respuesta diferente a los antes descritos deben ser tomados como errores de protocolo HTTPS.

Código de respuesta 400

{
   "code": 400,
   "message": "Validation Failed",
   "errors": {
       "errors": [
           "Saldo insuficiente para realizar este env\u00edo de dinero."
       ],
       "children": {
           "digitalAccountSource": [],
           "bank": [],
           "recipient": [],
           "saveContact": [],
           "identificationType": [],
           "identificationNumber": [],
           "amount": [],
           "message": []
       }
   }
}

Otro ejemplo de una respuesta 400:

{
   "code":400,
   "message":"Validation Failed",
   "errors":{
      "children":{
         "intent":{

         },
         "redirectUrls":{
            "children":{
               "returnUrl":{
                  "errors":[
                     "La URI de retorno es obligatoria."
                  ]
               },
               "cancelUrl":{
                  "errors":[
                     "La URI de cancelaci\u00f3n el obligatoria."
                  ]
               }
            }
         },
         "transactions":{
            "children":[
               {
                  "children":{
                     "digitalAccountDestination":{

                     },
                     "amount":{
                        "children":{
                           "total":{

                           },
                           "currency":{

                           },
                           "details":{
                              "children":{
                                 "shipping":{

                                 },
                                 "tax":{

                                 },
                                 "subTotal":{

                                 }
                              }
                           }
                        }
                     },
                     "description":{

                     },
                     "invoiceNumber":{

                     },
                     "items":{
                        "children":[
                           {
                              "children":{
                                 "name":{

                                 },
                                 "quantity":{

                                 },
                                 "sku":{

                                 },
                                 "price":{

                                 },
                                 "currency":{

                                 }
                              }
                           },
                           {
                              "children":{
                                 "name":{

                                 },
                                 "quantity":{

                                 },
                                 "sku":{

                                 },
                                 "price":{

                                 },
                                 "currency":{

                                 }
                              }
                           }
                        ]
                     },
                     "distributions":{

                     }
                  }
               }
            ]
         },
         "recipient":{

         }
      }
   }
}