Consultar un Pago

Obtiene la información de un pago en PinPad a partir de su pinpadRequestId.
Puedes incluir el encabezado opcional Pinpad-Include-Detail: true para obtener información más detallada del pago.

Para obtener la información detallada de la transacción, es necesario incluir el siguiente header en la petición:

Pinpad-Include-Detail: true

Ejemplo de cURL

curl --location 'https://api.payclip.io/f2f/pinpad/v1/payment?pinpadRequestId=pinpad-0d08e174-d7ca-4773-8ead-894bf7067bd0' \
--header 'Authorization: Basic ...' \
--header 'Pinpad-Include-Detail: true'

Cuando el header Pinpad-Include-Detail está presente en la solicitud, la respuesta incluirá el campo detail, el cual contiene información detallada de la transacción, incluyendo los siguientes datos:

{
    "pinpad_request_id": "pinpad-0d08e174-d7ca-4773-8ead-894bf7067bd0",
    "reference": "testpinpad-000211",
    "amount": "1.20",
    "amount_paid": "3.10",
    "tip_amount": "0.00",
    "create_date": "2025-02-20T15:32:26.432",
    "status": "COMPLETED",
    "detail": {
        "pages": {
            "size": 50,
            "number": 1,
            "total": 1,
            "total_results": 4
        },
        "results": [
            {
                "id": "7bd5f8a2-f230-410e-b4f5-1006f285b755",
                "transaction_id": "f473b6eb-a71e-480b-82a3-2e851188c46f",
                "type": "pos",
                "entry_mode": "qps",
                "amount": 0.5,
                "tip_amount": 0,
                "amount_refunded": 0,
                "installment_amount": 0.5,
                "installments": 1,
                "capture_method": "automatic",
                "net_amount": 0,
                "paid_amount": 0.5,
                "status": "approved",
                "approved_at": "2025-02-20T15:33:22Z",
                "currency": "MXN",
                "merchant_id": "27d8f6ba-9822-4b2d-9968-fb238b2c6dd5",
                "payment_method": {
                    "id": "master",
                    "type": "credit_card",
                    "card": {
                        "bin": "549949",
                        "issuer": "CITIBANAMEX",
                        "last_digits": "8356",
                        "exp_year": "26",
                        "exp_month": "08"
                    }
                },
                "device": {
                    "id": "P8C1231120001152",
                    "type": "Si",
                    "manufacturer": "KOZEN"
                }
            }
        ]
    }
}

Consideraciones clave

  • Si el header Pinpad-Include-Detail no se incluye en la solicitud, el campo detail no aparecerá en la respuesta.
  • El campo detail.results podría incluir varias transacciones relacionadas con el pago principal.

Llamada de prueba

Puedes realizar una llamada de prueba, únicamente asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en el botón "Try It!":

Query Params
string
required

ID de la solicitud del pago (pinpad_request_id) generado al crear el pago.

Headers
boolean

Si se envía con valor true, se devuelve información adicional del pago.

Responses
200

Información del pago encontrada

400

Petición inválida

404

No se encontró el pinpadRequestId

500

Error interno en el servidor

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!