Listar los cobros de una orden

GET

/orders/{orderKey}/payments

• Servidor de la API. El valor de host lo proporciona IDBI.

Devuelve todos los cobros registrados para la orden. Si la orden no tiene cobros, la respuesta es 200 con data vacío.

La orden debe pertenecer a una tienda a la que da acceso el token. Si pertenece a otra tienda o no existe, la respuesta es 403.

Authorizations

• OpenApiKey
• OpenApiToken

Parameters

Path Parameters

orderKey

required

string format: uuid

Identificador (UUID) de la orden.

Example

0f8d1c52-7a3e-4b19-9c64-2d5e8a1b7f30

Responses

200

Los cobros registrados en la orden, cada uno con su estado, importe, moneda y medio de pago. Sirve para consultar cómo se pagó una orden.

• La respuesta no está paginada ni tiene un orden garantizado.
• Una orden sin cobros responde 200 con data vacío.
• status indica el estado de cada cobro, por ejemplo approved o pending.
• Los importes son números JSON, no cadenas de texto como en sales.

object

data

required

Array<object>

object

uuid

required

Identificador del cobro.

string format: uuid

status

required

Estado del cobro, por ejemplo approved o pending.

string

amount

required

Importe del cobro.

number

total_amount

required

Importe total del cobro.

number

payable_amount

required

Importe a pagar del cobro.

number

approval_code

required

Código de aprobación del medio de pago, si existe.

string | null

reference_number

required

Número de referencia del medio de pago, si existe.

string | null

details

required

Detalle del cobro.

string

currency

required

object

uuid

required

Identificador de la moneda.

string format: uuid

name

required

Nombre de la moneda.

string

symbol

required

Símbolo de la moneda.

string

separator

required

Separador de la moneda, tal como está registrado en IDPOS.

string

payment_method

required

object

uuid

required

Identificador del método de pago.

string format: uuid

name

required

Nombre del método de pago.

string

type

required

Tipo del método de pago, por ejemplo cash, transfer o deposit.

string

image_url

required

URL de la imagen del método de pago, si existe.

string | null

Examples

Orden con un cobro

{
  "data": [
    {
      "uuid": "6b0f2d4e-91a7-4c35-8e12-5fd3a7c90b41",
      "status": "approved",
      "amount": 45.5,
      "total_amount": 45.5,
      "payable_amount": 45.5,
      "approval_code": null,
      "reference_number": null,
      "details": "Pago en caja",
      "currency": {
        "uuid": "719b61f7-0e77-4e7c-8e78-7a9b51791c29",
        "name": "PEN",
        "symbol": "S/",
        "separator": ","
      },
      "payment_method": {
        "uuid": "a41d8c07-3b6e-4f92-9d15-7c0e2b8f6a34",
        "name": "Efectivo",
        "type": "cash",
        "image_url": null
      }
    }
  ]
}

Orden sin cobros

{
  "data": []
}

401

Credenciales ausentes, inválidas, deshabilitadas o vencidas. El campo error.description indica el motivo.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

Falta una de las cabeceras

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es obligatorio"
  }
}

Token que no corresponde a la clave

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es inválido"
  }
}

Clave inexistente

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token no fue encontrado"
  }
}

Token deshabilitado

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token está deshabilitado"
  }
}

Token vencido

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token expiró"
  }
}

403

La orden indicada en la ruta no pertenece a una tienda del token. La respuesta es la misma para una orden de otra tienda y para una orden inexistente.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

{
  "error": {
    "code": 0,
    "message": "Acceso denegado",
    "description": "El token no tiene acceso a la orden solicitada"
  }
}