v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB

payin

Get payment intent detail

get/payin/intent/{id}

Path parameters

idstring uuid required

Intent id

Response

Success response

external_idstring

Id used to track the payin

conceptstring

Concept associated with the payment intent. This text will be reflected as a concept in the bank issuing the payment.

currencystring

ISO-4217 currency code

amountnumber double

String encoded decimal number

referencestring

Internal reference associated with the payment.

Example response

{
  "external_id": "e5af7e6e-98f4-4e43-af7e-6e98f42e43ef",
  "concept": "Some concept",
  "currency": "MXN",
  "amount": 10,
  "reference": "XBVTIQ3CQNN1ETFPG79TCC5IYA",
  "customer": {
    "name": "Jane Doe",
    "tax_id_type": "rfc",
    "tax_id": "DODJ2301016J3",
    "external_id": "SOME_PREFIX:SOME_UNIQUE_ID",
    "virtual_account": {
      "account_format": "clabe",
      "account_number": "012180826854179156",
      "name": "Jane Doe",
      "branch": "0",
      "bank": {
        "code": "012",
        "bicfi": "BBVAMXMMXXX",
        "name": "BBVA",
        "country": "MX"
      }
    },
    "qr_code": {
      "emv_code": "00020101021226830014...",
      "img": "base64...",
      "external_link": "https://example.com/?hash=...",
      "expire_date": "2026-12-31 23:59:59"
    }
  },
  "destination": {
    "account_number": "1939512312322150",
    "branch": "0",
    "owner_name": "CONSULTORA XXXXXXXX SAC",
    "account_format": "clabe",
    "tax_id_type": "rfc",
    "tax_id": "DODJ2301016J3",
    "bank": {
      "code": "012",
      "bicfi": "BBVAMXMMXXX",
      "name": "BBVA",
      "country": "MX"
    }
  },
  "events": [
    {
      "state": "created",
      "timestamp": "2024-09-30T18:00:58.087Z",
      "message": "payin created"
    }
  ]
}