Buscar transacciones

Buscar transaccionesServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/search.{format}

Devuelve una lista de transacciones basada en parámetros de búsqueda específicos. Como respuesta, recibirá datos sobre todos los pagos hechos en su juego, incluso si no fueron aceptados. Puede especificar no solo el periodo de la transacción, sino también otros parámetros, como p. ej., para buscar transacciones realizadas por un usuario concreto o en un estado de pago específico. Puede obtener la lista en formato JSON o CSV.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID de vendedor.
format required	string Formato de los datos. Enum: "json" "csv" "xls"

query Parameters

datetime_from

string <datetime>

Inicio del periodo.

datetime_to

string <datetime>

Fin del periodo.

project_id

integer

ID del proyecto.

transaction_id

integer

ID de la transacción.

type

string

Tipo de transacciones que aparecen en los resultados de búsqueda:

Enum:	Description
all	Todas las transacciones.
canceled	Transacciones canceladas, sin incluir las transacciones de prueba.
test	Transacciones de prueba.
transferred	Transacciones realizadas con éxito, sin incluir las transacciones de prueba.

phone

string

Número de teléfono en formato internacional.

user_id

string

ID único de usuario en el juego que está almacenado en su lado. Asegúrese de transmitir el ID de usuario existente. Si se produce un error, consulte las respuestas a las Preguntas frecuentes.

user_name

string

Nombre de usuario.

user_custom

string

Parámetro personalizado para la identificación del usuario.

string <= 100 characters

Correo del usuario.

external_id

string

ID de la transacción dentro del juego. Debe ser único para cada pago del usuario.

offset

integer

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

limit

integer

Límite para el número de elementos presentes en la página.

status

string

Un estado de transacción.

Enum:	Description
awaitingRefund	La transacción está pendiente de una decisión sobre el reembolso. Cuando el usuario haya solicitado un reembolso, el servicio de atención al cliente de Xsolla procesa la solicitud manualmente y adoptará una decisión sobre el reembolso.
canceled	Hay dos escenarios posibles: La transacción ha sido cancelada en el lado del sistema de pago. Por ejemplo, no había fondos suficientes en la cuenta del usuario. El pago fue reembolsado al usuario.
created	El usuario inició la transacción, pero esta aún no se ha procesado.
done	La transacción fue procesada correctamente.
error	Se produjo un error al procesar la transacción. Estos pagos pueden ser reembolsados si contacta con el equipo de atención al cliente de Xsolla.
partiallyRefunded	El usuario recibió un reembolso parcial.
processing	La transacción está siendo procesada.
refunded	Se hizo un reembolso al saldo de Xsolla del usuario.
review	El pago ha sido suspendido por el sistema antifraude y la transacción está siendo sometida a una verificación adicional.

Responses

200

OK.

Request samples

Response samples

application/json

[{"payment_details": {"payment": {"amount": 7.96,
"amount_from_ps": 7.96,
"currency": "RUB"
},
"sales_tax": {"amount": 0,
"percent": 0
}
},
"payment_system": {"decline_reason": null
},
"purchase": {"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"simple_checkout": {"amount": 7.96,
"currency": "RUB"
},
"subscription": {"name": null
},
"virtual_currency": {"amount": 0,
"name": null
},
"virtual_items": null
},
"transaction": {"create_date": "2021-10-20",
"dry_run": 0,
"external_id": "example-external-id",
"id": 123456789,
"is_refund_allowed": 0,
"payment_method": {"id": 1,
"name": "PayPal"
},
"project": {"id": 123456,
"name": "Example"
},
"refund_reason": null,
"status": "done",
"transfer_date": "2021-10-20"
},
"user": {"country": "RU",
"custom": null,
"email": "email@example.com",
"id": "example-id",
"name": "Example",
"phone": null
}
}
]