Pasarela Payment MyPay
  1. Payments
Pasarela Payment MyPay
  • Quick Start
  • Instalacion
  • Payments
    • Payments
      POST
    • Detalles de Transaccion
      POST
    • Paginacion y Filtro
      GET
    • Obtener validaciones de las transacciones
      GET
  1. Payments

Detalles de Transaccion

POST
/api/payments/query
Payments
Recupera el detalle y estado de una transacción ya procesada, para conciliación, servicio al cliente o auditoría.

Autenticación#

Requiere X-Api-Key válida.

Entradas#

Criterios de búsqueda: al menos un identificador fiable.
Alcance: resultados acotados al tenant asociado a la API Key.

Salida#

Resumen de la transacción: tipo (sale/refund/capture/etc.), condición (p. ej., complete), importes/códigos,
Acción/acciones registradas: respuesta textual y codificada del procesador, señales AVS/CVV, marca de tiempo del evento,
Trazabilidad: Trace Id.

Validaciones clave#

Al menos un identificador válido, no vacío.
Coherencia de filtros adicionales cuando se uses (rango de fechas, paginación, etc., si están habilitados).

Errores simulados#

400 Bad Request: parámetros faltantes o inválidos.
401 Unauthorized: API Key inválida/inactiva.
404 Not Found: transacción inexistente para el tenant de la API Key.
Notas: Úsalo para confirmar resultados mostrados al usuario, reconciliar con back-office y cerrar disputas.
El detalle devuelto puede incluir historial de acciones (p. ej., sale seguido de refund).

Solicitud

Parámetros de Header

Parámetros del Body application/json

Ejemplos

Respuestas

🟢200OK
application/json
OK
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
🔴500Internal Server Error
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.mypaygateway.io/api/payments/query' \
--header 'X-Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "securityKey": "string",
    "condition": "string",
    "transactionType": "string",
    "actionType": "string",
    "source": "string",
    "transactionId": "string",
    "subscriptionId": "string",
    "invoiceId": "string",
    "partialPaymentId": "string",
    "orderId": "string",
    "firstName": "string",
    "lastName": "string",
    "address1": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "phone": "string",
    "fax": "string",
    "orderDescription": "string",
    "driversLicenseNumber": "string",
    "driversLicenseDob": "string",
    "driversLicenseState": "string",
    "email": "string",
    "creditCardNumber": "string",
    "merchantDefinedFields": {
        "property1": "string",
        "property2": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "reportType": "string",
    "mobileDeviceLicense": "string",
    "mobileDeviceNickname": "string",
    "customerVaultId": "string",
    "dateSearch": "string",
    "resultLimit": 0,
    "pageNumber": 0,
    "resultOrder": "string",
    "invoiceStatus": "string",
    "processorDetails": true
}'
Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
    "transaction": [
        {
            "transactionId": "string",
            "partialPaymentId": "string",
            "partialPaymentBalance": "string",
            "platformId": "string",
            "transactionType": "string",
            "condition": "string",
            "orderId": "string",
            "authorizationCode": "string",
            "poNumber": "string",
            "orderDescription": "string",
            "firstName": "string",
            "lastName": "string",
            "address1": "string",
            "address2": "string",
            "company": "string",
            "city": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string",
            "email": "string",
            "phone": "string",
            "fax": "string",
            "cellPhone": "string",
            "customerTaxId": "string",
            "customerId": "string",
            "website": "string",
            "shippingFirstName": "string",
            "shippingLastName": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingCompany": "string",
            "shippingCity": "string",
            "shippingState": "string",
            "shippingPostalCode": "string",
            "shippingCountry": "string",
            "shippingEmail": "string",
            "shippingCarrier": "string",
            "trackingNumber": "string",
            "shippingDate": "string",
            "shipping": "string",
            "shippingPhone": "string",
            "ccNumber": "string",
            "ccHash": "string",
            "ccExp": "string",
            "cavv": "string",
            "cavvResult": "string",
            "xid": "string",
            "eci": "string",
            "directoryServerId": "string",
            "threeDsVersion": "string",
            "avsResponse": "string",
            "cscResponse": "string",
            "cardholderAuth": "string",
            "ccStartDate": "string",
            "ccIssueNumber": "string",
            "checkAccount": "string",
            "checkHash": "string",
            "checkAba": "string",
            "checkName": "string",
            "accountHolderType": "string",
            "accountType": "string",
            "secCode": "string",
            "driversLicenseNumber": "string",
            "driversLicenseState": "string",
            "driversLicenseDob": "string",
            "socialSecurityNumber": "string",
            "processorId": "string",
            "tax": "string",
            "currency": "string",
            "surcharge": "string",
            "convenienceFee": "string",
            "miscFee": "string",
            "miscFeeName": "string",
            "cashDiscount": "string",
            "tip": "string",
            "cardBalance": "string",
            "cardAvailableBalance": "string",
            "entryMode": "string",
            "ccBin": "string",
            "ccType": "string",
            "signatureImage": "string",
            "dutyAmount": "string",
            "discountAmount": "string",
            "nationalTaxAmount": "string",
            "summaryCommodityCode": "string",
            "vatTaxAmount": "string",
            "vatTaxRate": "string",
            "alternateTaxAmount": "string",
            "action": {
                "amount": "string",
                "actionType": "string",
                "date": "string",
                "success": "string",
                "ipAddress": "string",
                "source": "string",
                "apiMethod": "string",
                "tapToMobile": "string",
                "username": "string",
                "responseText": "string",
                "batchId": "string",
                "processorBatchId": "string",
                "responseCode": "string",
                "processorResponseText": "string",
                "processorResponseCode": "string",
                "deviceLicenseNumber": "string",
                "deviceNickname": "string"
            }
        }
    ]
}
Modificado en 2025-11-17 21:29:08
Anterior
Payments
Siguiente
Paginacion y Filtro
Built with