Obtener Pago por ID Externo

Consulte los detalles completos de un pago, incluyendo su historial de ciclo de vida, comisiones e información de la tarjeta.

Endpoint

GET https://{FQDN}/payments/{externalPaymentId}

Encabezados:

Encabezado	Valor
`Authorization`	`Bearer {accessToken}`

Ejemplo de Solicitud

curl -X GET https://{FQDN}/payments/order-12345 \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Respuesta (200)

{
  "parentPaymentId": "9a8dd6f3-105c-40a9-be13-ed95b2b2274b",
  "externalId": "order-12345",
  "requestedOn": "2025-01-21 17:15:14",
  "capturedOn": "2025-01-18 14:59:53",
  "refundedOn": "2025-01-21 17:15:14",
  "amount": 57.00,
  "capturedAmount": 57.00,
  "refundedAmount": 57.00,
  "amountRequested": 57.00,
  "currency": "USD",
  "status": "REFUNDED",
  "approved": true,
  "billing": {
    "stateCode": "FL",
    "city": "Orlando",
    "line1": "12516 Britwell Ct",
    "state": "FL",
    "zipCode": "32837"
  },
  "ipAddress": "203.0.113.42",
  "customer": {
    "firstName": "MIKE",
    "lastName": "JOSEPH",
    "phoneNumber": "+1231232123",
    "email": "[email protected]"
  },
  "transactionFees": [
    {
      "sourceId": "9a8dd6f3-...",
      "source": "PAYMENT",
      "eventId": "PRE_AUTH",
      "dtCreated": "2025-01-18 14:59:48",
      "amount": 0.57
    },
    {
      "sourceId": "0e444b74-...",
      "source": "PAYMENT",
      "eventId": "CAPTURE",
      "dtCreated": "2025-01-18 14:59:53",
      "amount": 0.00
    },
    {
      "sourceId": "9989afba-...",
      "source": "PAYMENT",
      "eventId": "REFUND",
      "dtCreated": "2025-01-21 17:15:14",
      "amount": 0.00
    }
  ],
  "history": [
    {
      "paymentId": "9a8dd6f3-...",
      "requestedOn": "2025-01-18 14:59:47",
      "code": "PAYMENT",
      "status": "AUTHORIZED",
      "description": "Payment Approved",
      "requestedAmount": 57.00
    },
    {
      "paymentId": "0e444b74-...",
      "requestedOn": "2025-01-18 14:59:53",
      "code": "CAPTURE",
      "status": "CAPTURED",
      "description": "Payment Approved",
      "requestedAmount": 57.00
    },
    {
      "paymentId": "9989afba-...",
      "requestedOn": "2025-01-21 17:15:14",
      "code": "REFUND",
      "status": "REFUNDED",
      "description": "Payment Approved",
      "requestedAmount": 57.00
    }
  ],
  "card": {
    "lastFourDigits": "2929",
    "bin": "479213",
    "schemeId": "VISA",
    "issuer": "TD BANK, NATIONAL ASSOCIATION",
    "country": "UNITED STATES",
    "countryCode": "US",
    "cardType": "DEBIT",
    "cardCategory": "CLASSIC",
    "currencyCode": "USD"
  }
}

Campos de la Respuesta

Raíz

Campo	Tipo	Descripción
`parentPaymentId`	string	ID del pago raíz
`externalId`	string	Su ID de pago externo
`requestedOn`	string	Marca de tiempo de la operación más reciente
`capturedOn`	string	Marca de tiempo de la captura (null si no fue capturado)
`refundedOn`	string	Marca de tiempo del reembolso (null si no fue reembolsado)
`amount`	number	Monto original autorizado
`capturedAmount`	number	Monto que fue capturado
`refundedAmount`	number	Monto que fue reembolsado
`currency`	string	Código de moneda ISO 4217
`status`	string	Estado actual del pago
`approved`	boolean	Si el pago fue aprobado

`transactionFees[]`

Campo	Descripción
`eventId`	Evento de comisión: `PRE_AUTH`, `CAPTURE`, `REFUND`
`amount`	Monto de la comisión para este evento
`dtCreated`	Cuándo se incurrió la comisión

`history[]`

Campo	Descripción
`paymentId`	ID de la operación específica
`code`	Tipo de operación: `PAYMENT`, `CAPTURE`, `REFUND`
`status`	Estado después de esta operación
`requestedAmount`	Monto de esta operación

`card`

Campo	Descripción
`lastFourDigits`	Últimos 4 dígitos de la tarjeta
`bin`	Número de Identificación Bancaria (primeros 6 dígitos)
`schemeId`	Red de tarjetas: `VISA`, `MASTERCARD`, etc.
`issuer`	Nombre del banco emisor
`cardType`	`DEBIT` o `CREDIT`
`cardCategory`	Nivel de la tarjeta (p. ej., `CLASSIC`, `GOLD`, `PLATINUM`)

v2 — Consulta de Pago Enriquecida

El endpoint v2 devuelve el mismo objeto de pago que v1, más metadatos de la tarjeta y detalle de facturación adicionales, útiles para la revisión de fraude y la conciliación. Prefiera v2 cuando necesite el resultado de AVS/CVC o el perfil completo de la tarjeta a nivel de BIN junto con el pago.

GET https://{FQDN}/v2/payment/{externalId}

Encabezados:

Encabezado	Valor
`Authorization`	`Bearer {accessToken}`

Ejemplo de Solicitud

curl -X GET https://{FQDN}/v2/payment/order-12345 \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Campos Adicionales en v2

El objeto raíz, transactionFees[], history[] y customer son idénticos a v1. Las diferencias son:

billing — añade countryCode (código de país ISO) junto a los existentes stateCode, city, line1, line2, state y zipCode.

card — añade los siguientes campos sobre el conjunto de v1:

Campo	Descripción
`binNumber`	Identificador completo del rango BIN (`bin` extendido)
`country`	Nombre del país emisor
`countryCode`	País emisor (ISO Alfa-2)
`countryCode3`	País emisor (ISO Alfa-3)
`currencyCode`	Moneda nativa de la tarjeta
`avsStatus`	Resultado de la Verificación de Dirección registrado para el pago (`APPROVED`, `FAILED`, `NOT_SENT`, `N/A`)
`cvcStatus`	Resultado de la Verificación de Tarjeta registrado para el pago (`APPROVED`, `FAILED`, `NOT_SENT`, `N/A`)

{
  "card": {
    "lastFourDigits": "2929",
    "bin": "479213",
    "binNumber": "47921300",
    "schemeId": "VISA",
    "issuer": "TD BANK, NATIONAL ASSOCIATION",
    "country": "UNITED STATES",
    "countryCode": "US",
    "countryCode3": "USA",
    "cardType": "DEBIT",
    "cardCategory": "CLASSIC",
    "currencyCode": "USD",
    "avsStatus": "APPROVED",
    "cvcStatus": "APPROVED"
  }
}

Nota de migración: v2 es aditivo — cada campo presente en la respuesta v1 se sigue devolviendo con el mismo nombre y tipo, por lo que una integración v1 existente puede cambiar a v2 sin romperse.