El recurso de API de transacciones permite obtener los detalles de una o más transacciones. Una transacción individual se identifica por su número de recibo receipt_no. Una lista de transacciones se define por un rango de fechas específico.

El objeto payment muestra la información relacionada a una transacción individual. Contiene detalles del lugar en que se realiza el pago, método de pago, estado actual de la transacción y fecha.

{
    "query":     {
            "receipt_no": "1iNzWOR"
    },
    "meta": {
            “item_type” : “payment”
    },
    "item": {
            "receipt_no": "1iNzWOR",
            "created_at": "2020-01-10T14:36:13.745Z",
            "location":{
                "latitude":-111.9060182,
                "longitude":111.9060182
            },
            "status": "Paid",
            "amount": 200,
            "currency": "MXN",
            "terms": null,
            "tip": 0,
            "total": 200,
            "payment_method": "Credit",
            "sub_type": "SWIPE", 
            "card": {
                "brand": "MasterCard",
                "last4": "4352",
                "issuer": "BANAMEX"
            },
            "merchant_invoice": null,
            "user_email": "[email protected]"
    },
    "response_messages": []
}
{
    "query":     {
            "receipt_no": "1iNzWOR"
    },
    "meta": null,
    "item": null,
    "response_messages": [{
          "severity": "Error",
          "code": "payclip.not.found",
          "text": "Could not find the receipt no."
    }]
}

La siguiente tabla contiene los elementos de la estructura del objeto de respuesta para una transacción individual:

Elemento

Descripción

Tipo

query

Object

receipt_no

Identificador único de la transacción

String

meta

Object

item_type

Tipo de modelo de datos en la respuesta. En esta respuesta el tipo es payment.

String

item

Objeto de tipo item

Object

receipt_no

ID de la transacción

String

created_at

Fecha de creación del pago

String

location

Objeto que contiene la información de ubicación

String

latitude

Coordenada de latitud para la ubicación de la transacción

String

longitude

Coordenada de longitud para la ubicación de la transacción

String

status

Estado de la transacción al momento de realizar la consulta.

Lista de posibles estados:

  • Paid
  • Cancelled
  • Declined

string

amount

Cantidad del pago

Float

currency

Código de divisa para la transacción del pago conforme a ISO 4217

String

terms

Indica si el pago se difiere en mensualidades

String

tip

Cantidad de la propina

Float

total

Cantidad total del pago incluyendo propina

Float

payment_method

Especifica la categoría de la forma de pago:

  • DEBIT: la tarjeta es de débito
  • CREDIT: la tarjeta es de crédito
  • OTHER: la tarjeta no es de débito ni crédito, por ejemplo, tarjeta de vales

String

sub_type

Especifica detalles adicionales del tipo de pago en payment_method:

  • KEYED: Número de tarjeta de crédito ingresada manualmente
  • SWIPE: pago con tarjeta de banda magnética
  • EMV_SIGNATURE: pago con tarjeta de chip y verificación con firma
  • CARD_ON_FILE: el flujo de pago usa datos de una tarjeta almacenada previamente
  • EMV_PIN: pago con tarjeta de chip y verificación con pin
  • NFC_SWIPE: pago contactless
  • NFC_EMV_SIGNATURE: pago contactless
  • ECOMMERCE: pago a distancia

String

card

Objeto que contiene detalles de la tarjeta utilizada

Object

brand

Tipo de tarjeta utilizada para el pago

String

last4

Últimos cuatro dígitos de la tarjeta utilizada para el pago

String

issuer

Banco emisor de la tarjeta

String

merchant_invoice

Referencia alfanumérica proporcionada por el vendedor

String

user_email

Correo electrónico del usuario Clip

String

response_messages

Objeto con información relacionada al mensaje de error

Object

severity

Tipo de problema encontrado

String

code

Mapeo del código para el error específico en el campo severity

Ejemplo: payclip.bad.request

String

text

Descripción para el código de error correspondiente

Ejemplo: payment not found

String

La siguiente tabla contiene los elementos de la estructura del objeto de respuesta para una lista de transacciones de un periodo de fechas definido:

{
    "items": [
        {
            "receipt_no": "WpJi058",
            "created_at": "2020-07-30T18:52:42Z",
            "location": {
                "longitude": "-103.3657798",
                "latitude": "20.7009265"
            },
            "user_email": "[email protected]",
            "status": "Paid",
            "payment_method": "CREDIT",
            "sub_type": "EMV_SIGNATURE",
            "card": {
                "brand": "MC",
                "issuer": "BANAMEX",
                "last4": "4352"
            },
            "currency": "MXN",
            "terms": null,
            "amount": "150.00",
            "tip": "0.00",
            "total": "150.00",
            "merchant_invoice": ""
        }
    ],
    "query": {
        "pagination_token": "",
        "limit": "1",
        "from": "2020-07-01T10:10:50Z",
        "to": "2020-08-01T07:32:50Z",
        "last4": "1234",
        "status": "Approved"
    },
    "response_messages": [],
    "meta": {
        "limit": "1",
        "pagination_token": "Mg==",
        "from": "2020-07-01T10:10:50Z",
        "to": "2020-08-01T07:32:50Z",
        "item_type": "Payment"
    }
}
{
"items": [],
"query": {
      "pagination_token": "",
            "limit": "12",
            "from": "2019-09-25T04:38:00Z",
            "to": "2019-10-23"
    },
"response_messages": [
       {
         "severity": "error",
         "code": "payclip.bad.request",
         "text": "bad request"
       }
      ],
"meta": {
            "limit": "12",
            "pagination_token": "",
            "from": "2019-09-25T04:38:00Z",
            "to": "2019-10-23",
            "item_type": "Payment"
      }
}

Elemento

Descripción

Tipo

items

Arreglo de objetos con esquema payment

Object

receipt_no

ID de la transacción

String

created_at

Fecha de creación del pago

String

location

Objeto que contiene la información de ubicación

String

latitude

Coordenada de latitud para la ubicación de la transacción

String

longitude

Coordenada de longitud para la ubicación de la transacción

String

user_email

Correo electrónico del usuario Clip

String

status

Estado de la transacción al momento de realizar la consulta.

Lista de posibles estados:

  • Approved
  • Cancelled
  • Declined

string

payment_method

Especifica la categoría de la forma de pago:

  • DEBIT: la tarjeta es de débito
  • CREDIT: la tarjeta es de crédito
  • OTHER: la tarjeta no es de débito ni crédito, por ejemplo, tarjeta de vales

String

sub_type

Especifica detalles adicionales del tipo de pago en payment_method:

  • KEYED: Número de tarjeta de crédito ingresada manualmente
  • SWIPE: pago con tarjeta de banda magnética
  • EMV_SIGNATURE: pago con tarjeta de chip y verificación con firma
  • CARD_ON_FILE: el flujo de pago usa datos de una tarjeta almacenada previamente
  • EMV_PIN: pago con tarjeta de chip y verificación con pin
  • NFC_SWIPE: pago contactless
  • NFC_EMV_SIGNATURE: pago contactless
  • ECOMMERCE: pago a distancia

String

card

Objeto que contiene detalles de la tarjeta utilizada

Object

brand

Tipo de tarjeta utilizada para el pago

String

last4

Últimos cuatro dígitos de la tarjeta utilizada para el pago

String

issuer

Banco emisor de la tarjeta

String

currency

Código de divisa para la transacción del pago conforme a ISO 4217

String

terms

Indica si el pago se difiere en mensualidades

String

amount

Cantidad del pago

Float

tip

Cantidad de la propina

Float

total

Cantidad total del pago incluyendo propina

Float

merchant_invoice

Referencia alfanumérica proporcionada por el vendedor

String

query

Object

pagination_token

Cadena de base 64 utilizada para la paginación de los resultados

Admite valor nulo: true

String

limit

Número de elementos a mostrar por página

Preestablecido: 20

Límite: 100

String

from

Fecha de inicio de la solicitud de consulta

String

to

Fecha de fin de la solicitud de consulta

String

last4

Últimos cuatro dígitos del número de tarjeta utilizada para el pago

String

status

Estado de la transacción.

Lista de posibles estados:

  • paid
  • cancelled

String

messages

Arreglo de objetos con información relacionada al mensaje de error

Array

severity

Tipo de problema encontrado

String

code

Mapeo del código para el error específico en el campo severity

String

text

Descripción para el código de error correspondiente

String

meta

Object

from

Fecha de inicio que incluye la lista

String

to

Fecha de fin que incluye la lista

String

pagination_token

Cadena de base 64 utilizada para la paginación de los resultados

Admite valor nulo: true

String

limit

Número de elementos a mostrar por página

Preestablecido: 20

Límite: 100

String

item_type

Tipo de modelo de datos en la respuesta. En esta respuesta el tipo es payment

String