Saltar al contenido principal

get-order-refunds

Este método obtiene los reembolsos realizados a una orden (se utiliza paginación para la consulta ordenada).

Notas

La ordenes realizadas dentro de la app de Mercado.VIP pueden ser reembolsadas, esto unicamente desde la plataforma de AceptaBits, no es posible realizar reembolsos por medio de API.

Si necesitas más información sobre cómo funciona la paginación consulta la sección: Paginación.

Los resultados se ordenan de manera descendente por fecha en la que se genero el pago.

Path del método​

get-order-refunds

Endpoint final​

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/get-order-refunds

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/get-order-refunds

Método de petición HTTP​

GET

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
pageSiEs la página que se utilizara en la paginación de la peticiónEjemplo:
1, 2, 3, etc.

Este valor debe ser numérico y entero, indicara la página actual a la cual se hará la consulta
limitSiEs el límite de elementos que se utilizara en la paginación de la peticiónEjemplo:
5, 10, 20, 50, etc.

Este valor debe de ser numérico y entero, con un valor máximo posible de 100, si se envía un número mayor a 100 se realizará la consulta con el valor 100
codeSiEl código de la orden a la que se realizará la consultaEjemplo:
pgbord17799727777894479

Deberás de ingresar el código de la orden a la cual quieres consultar los reembolsos

Lista de códigos​

Exitoso
CódigoDescripción
0188Información de los reembolsos obtenida con éxito

 

Error
CódigoDescripción
0000El Token API no es correcto y la autenticación del usuario ha fallado
0003El Token API no es correcto y la autenticación del usuario ha fallado
2242El Token API no es correcto y la autenticación del usuario ha fallado
2243El código de la orden es requerido
2244El campo página de la paginación es requerido
2245El campo límite de la paginación es requerido
2246La orden que se intenta consultar no existe (el código de la orden es incorrecto)
2247El Token API no es correcto y la autenticación del usuario ha fallado
2248Ocurrió un problema al obtener el listado de reembolsos de la órden, inténtelo nuevamente o consulte con soporte técnico para más ayuda

Respuesta EXITOSA​

Exitoso

Código HTTP 200

{
    "status": true,
    "success": {
        "code": "0188"
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "code_order": "pgbord532125147249163154",
                "code_product": "pgbpro11933149798178630",
                "name_product": "torta ahogada",
                "code_extra": null,
                "name_extra": null,
                "quantity": "1.00000000",
                "unit_price_mxn": "70.50000000",
                "amount_refund_customer": "70.50000000",
                "amount_refund_seller": "66.98000000",
                "code_currency": "PBT",
                "name_currency": "PesoBits",
                "created_at": "2025-08-19T00:03:57.000000Z",
                "created_at_format": "2025-08-18 18:03:57"
            },
            {
                "code_order": "pgbord532125147249163154",
                "code_product": "pgbpro11933149798123968",
                "name_product": "jugo verde",
                "code_extra": null,
                "name_extra": null,
                "quantity": "1.00000000",
                "unit_price_mxn": "30.00000000",
                "amount_refund_customer": "30.00000000",
                "amount_refund_seller": "28.49000000",
                "code_currency": "PBT",
                "name_currency": "PesoBits",
                "created_at": "2025-08-18T23:47:40.000000Z",
                "created_at_format": "2025-08-18 17:47:40"
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • data - Se obtiene la información de los pagos y la información actual de la paginación
    • current_page - Indica cual es la página actual en la paginación
    • last_page - Indica cual es el último número de página posible (este valor cambia dependiendo del límite de elementos por página que se envio con el parametro limit)
    • per_page - Indica el límite de elementos mostrados por pagina
    • from - indica el índice inicial de la numeración de los clientes mostrado en esta pagina
    • to - indica el índice final de la numeración de los clientes mostrado en esta pagina
    • total - Indica el número de total de elementos que existen
    • data - Arreglo donde se listan los pagos que tiene la orden consultada
      • code_order - Código de la orden consultada
      • code_product - Código del producto reembolsado (NULL si no se reembolso un producto)
      • name_product - Nombre del producto reembolsado (NULL si no se reembolso un producto)
      • code_extra - Código del extra reembolsado (NULL si no se reembolso un extra)
      • name_extra - Nombre del extra reembolsado (NULL si no se reembolso un extra)
      • quantity - Cantidad de articulos reembolsados
      • unit_price_mxn - Precio unitario en MXN del articulo reembolsado
      • amount_refund_customer - Monto reembolsado al cliente (cliente perteneciente a la plataforma de Mercado.VIP y el cual realizo el pago de la orden)
      • amount_refund_seller - Monto retirado de la wallet del vendedor (dueño de la cuenta de AceptaBits)
      • created_at - Fecha y hora de creación del pago (UTC)
      • created_at_format - Fecha y hora de creación del pago (America/Mexico_City)
Nota
  • Si el campo data está vacío y se realizaron reembolsos, favor de comunicarse a soporte técnico

Respuesta FALLIDA​

Error

Código HTTP 400, Código HTTP 401, Código HTTP 500


{
    "status": false,
    "error": {
        "code": "2246"
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos ERROR para conocer la causa y saber cómo corregir
  • Si se obtiene un código HTTP 500 favor de comunicarse a soporte técnico
  • Si se obtiene un código HTTP 401 revisar que el Token API este correcto
Notas

Si tienes alguna duda recuerda que siempre puedes contactar con el equipo de soporte para desarrolladores ingresando en el siguiente enlace: Soporte para desarrolladores.