Obtener Pagos de una Transacción

Este método permite obtener los pagos asociados a una transacción utilizando un identificador de venta o un identificador interno en el sistema de Colaborador.

1. Método de Acceso

Parámetro	Descripción
URL	{baseurl}/api/salepayments
Verbo HTTP	GET
Longitud máxima de URL	2048 caracteres

2. Datos de Envío

Campo	Descripción
ApiKey	Clave única y privada para el colaborador.
SaleId	[Opcional] Identificador de la venta. Si no se especifica, se debe enviar PartnerSaleId.
PartnerSaleId	[Opcional] Identificador interno de la venta en Colaborador. Si no se especifica, se debe enviar SaleId.
api-version	Parámetro opcional para indicar la versión del API. Por defecto es 3.21.

⚠️ Consideraciones:

Se debe proporcionar SaleId o PartnerSaleId, pero no ambos.
SaleId es el identificador de venta en el API de Experticket.
PartnerSaleId es el identificador interno de la venta en Colaborador.

3. Ejemplo de Petición

GET {baseurl}/api/salepayments?ApiKey={apiKey}&PartnerSaleId=965875680289

Content-Type: application/json

4. Estructura de la Respuesta

Si la solicitud es exitosa, se devuelve un array de pagos asociados a la transacción.

Campo	Descripción
Payments	Array de pagos.
PaymentCommerceIdentifier	Identificador del comercio que ha procesado el pago.
Amount	Importe del pago realizado.
AuthorizationCode	Código de autorización emitido por la entidad procesadora del pago.
OperationDateTime	Fecha y hora en que se realizó el pago.
Success	true si la solicitud fue exitosa, false si hubo un error.
Timestamp	Marca de tiempo de la respuesta.
ErrorMessage	Mensaje de error si la solicitud falla.
ErrorCodes	Array con códigos de error (si aplica).

5. Ejemplo de Respuesta Exitosa

{

"Payments": [

{

"PaymentCommerceIdentifier": "5194660864094625940",

"Amount": "60.50",

"AuthorizationCode": "7BHJ989343498",

"OperationDateTime": "2024-03-14T10:22:50.5875456"

}

"Success": true,

"Timestamp": "2024-03-18T17:02:27.8165916",

"ErrorEntityBreakDown": []

}

6. Ejemplo de Respuesta con Error

{

"Success": false,

"ErrorMessage": "El identificador de venta no es válido.",

"Timestamp": "2024-02-05T12:45:00.000Z",

"ErrorCodes": [105]

}

7. Consideraciones Finales

Este método es útil para obtener información sobre pagos realizados en una transacción dentro de Colaborador.
Si Success = false, revisar ErrorMessage y ErrorCodes.
Almacenar los SaleId y PartnerSaleId para futuras referencias y evitar problemas en la recuperación de pagos.

Home

API