get-order-payments

Este método obtiene los pagos realizados a una orden, tanto ordenes normales como ordenes de tipo recurrente (se utiliza paginación para la consulta ordenada).

Notas

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-payments

Endpoint final

PRODUCCION

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

SANDBOX DE PRUEBAS

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

---

Método de petición HTTP

GET

Lista de parámetros

Parámetro	Obligatorio	Descripción	valor
page	Si	Es la página que se utilizara en la paginación de la petición	Ejemplo: 1, 2, 3, etc. Este valor debe ser numérico y entero, indicara la página actual a la cual se hará la consulta
limit	Si	Es el límite de elementos que se utilizara en la paginación de la petición	Ejemplo: 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
code	Si	El código de la orden a la que se realizará la consulta	Ejemplo: pgbord17799727777894479 Deberás de ingresar el código de la orden a la cual quieres consultar los pagos

---

Lista de códigos

Exitoso

Código	Descripción
0185	Información de los pagos obtenida con éxito

 

Error

Código	Descripción
0000	El Token API no es correcto y la autenticación del usuario ha fallado
0003	El Token API no es correcto y la autenticación del usuario ha fallado
2218	El Token API no es correcto y la autenticación del usuario ha fallado
2219	El código de la orden es requerido
2220	El campo página de la paginación es requerido
2221	El campo límite de la paginación es requerido
2222	La orden que se intenta consultar no existe (el código de la orden es incorrecto)
2223	El Token API no es correcto y la autenticación del usuario ha fallado
2224	Ocurrió un problema al obtener el listado de pagos de la órden, inténtelo nuevamente o consulte con soporte técnico para más ayuda

---

Respuesta EXITOSA

Exitoso

Código HTTP 200

//Orden de tipo normal:
{
    "status": true,
    "success": {
        "code": "0185"
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "code_order": "pgbord36984879982162127",
                "amount": 5,
                "code_currency": "PesoBits",
                "name_currency": "PBT",
                "created_at": "2025-01-22T22:33:20.000000Z",
                "created_at_format": "2025-01-22 17:33:20"
            }          
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

//Orden de tipo recurrente:
{
    "status": true,
    "success": {
        "code": "0185"
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "code_order": "pgbord36984879326987451",
                "payment_amount": 5,
                "commission": 0.075,
                "amount": 4.925,
                "code_currency": "USDT",
                "name_currency": "Tether USDT",
                "created_at": "2025-05-28T00:22:04.000000Z",
                "created_at_format": "2025-05-27 19:22:04"
            },
            {
                "code_order": "pgbord36984879326987451",
                "payment_amount": 5,
                "commission": 0.075,
                "amount": 4.925,
                "code_currency": "USDT",
                "name_currency": "Tether USDT",
                "created_at": "2025-05-28T00:22:04.000000Z",
                "created_at_format": "2025-05-27 19:22:04"
            }
        ],
        "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
    • payment_amount - Muestra el monto total del pago (solo para ordenes de tipo recurrente)
    • commission - Muestra el monto de comision del pago (solo para ordenes de tipo recurrente)
    • amount - Para ordenes de tipo normal muestra el monto del pago recibido, para ordenes de tipo recurrente muestra el monto final del pago (payment_amount menos commission)
    • code_currency - Muestra el código de la moneda con la que se genero el pago
    • name_currency - Muestra el nombre de la moneda con la que se genero el pago
    • 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, 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": "2223"
    }
}

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.