paycools-mex-en
Languages
Languages
  • 简体中文
  • English
Languages
Languages
  • 简体中文
  • English
  1. 1. Tax Service
  • Unified API Request Parameters
  • Unified Asynchronous Notification Parameters
  • API Common Response Codes
  • 1. Tax Service
    • Ticket
    • 1.1 Register Tax Ticket
      POST
    • 1.4 Replace Tax Ticket
      POST
    • 1.5 Tax Ticket Status Notification
      POST
    • 1.3 Cancel Tax Ticket
      POST
    • 1.2 Query Tax Ticket
      POST
  • 2. Payment - Static Order
    • Channel List
    • 2.1 CLABE Creation API
      POST
    • 2.2 CLABE Details Query API
      POST
    • 2.3 CLABE Collection Query API
      POST
    • 2.4 CLABE Collection Notification
      POST
  • 3. Payout
    • Payout Channel List
    • 3.1 Create Payout
      POST
    • 3.2 Check Payout Status
      POST
    • 3.3 Payout Notification
      POST
  1. 1. Tax Service

Ticket

Ticket Json Field Description#

Main Table Field Description#

PayCools External Field NameRequiredTypeDescription
mchRreceiptIdYstringInternal receipt number (merchant internal serial number/invoice number), supports alphanumeric
numberReferenceYstringReference number, unique (example: 2024112501020812345678002)
issueDateTimeYstring (datetime)Invoice date time, format YYYY-MM-DD hh:mm:ss, must be local time of the invoicing location
totalAmountYnumberTotal amount = subtotal - discount + transferred taxes - withholding taxes. Cannot be negative
paymentFormY (conditional)stringPayment method code (SAT catalog). For example, 01=cash
paymentMethodY (conditional)stringPayment method code: PUE=single payment, PPD=installment payment
currencyYstringCurrency code, ISO 4217, for example MXN
voucherTypeYstringInvoice type: I=income, E=expense, T=transfer, N=payroll
issuePlaceYstringInvoice location postal code (headquarters or branch address)
emailNstringCustomer email, internal use only
branchKeyYstringBranch or store code (internal identifier)
itemsYarrayProduct/service detail list

items(Conceptos) Field Description#

PayCools External Field NameRequiredTypeDescription
productServiceKeyYstringProduct/service code (SAT Product and Service Catalog)
itemIDNstringSKU/barcode/product number (merchant's own coding)
quantityYnumberProduct/service quantity
unitKeyYstringUnit code (SAT Unit Catalog), for example H87=piece
unitNameNstringUnit name (for internal display)
descriptionYstringProduct/service description
unitPriceYnumberUnit price (excluding tax)
amountYnumberAmount (= quantity × unit price)
discountNstringDiscount
taxesNarrayTax details (transferred/withholding)

taxes(Impuestos)Tax Detail Fields#

PayCools External Field NameRequiredTypeDescription
taxTypeNstringTax type: T=transferred tax, R=withholding tax
taxBaseYnumberTax base amount. Usually equal to the corresponding Concepto's Importe
taxCodeYstringTax code, 002=IVA
rateTypeYstringRate type: Tasa=rate, Cuota=fixed amount, Exento=exempt
rateYnumberTax rate, for example 0.160000=16%
taxAmountYnumberTax amount = Base × Tasa
Ticket Example:
{ "mchRreceiptId": "987630", "numberReference": "202510131561234098711110030", "issueDateTime": "2025-09-22 00:01:08.00", "totalAmount": 264.99, "paymentForm": "01", "paymentMethod": "PUE", "currency": "MXN", "voucherType": "I", "issuePlace": "77503", "email": "haxilama@ejemplo.com", "branchKey": "10", "items": [ { "productServiceKey": "90101500", "itemID": "202510131561234098711110001", "quantity": "1", "unitKey": "E48", "unitName": "UnidaddeServicio", "description": "xxxhaxilmawuhuwuhuwuhu:12345678FechadeConsumo2024-11-2501:02:08.000", "unitPrice": 228.44, "amount": 228.44, "discount": 0.0, "taxes": [ { "taxType": "T", "taxBase": 228.44, "taxCode": "002", "rateType": "Tasa", "rate": 0.16, "taxAmount": 36.55 } ] } ] }
Example of a Ticket after base64 encoding:
ewogICAgIm1jaFJyZWNlaXB0SWQiOiAiOTg3NjMwIiwKICAgICJudW1iZXJSZWZlcmVuY2UiOiAiMjAyNTEwMTMxNTYxMjM0MDk4NzExMTEwMDMwIiwKICAgICJpc3N1ZURhdGVUaW1lIjogIjIwMjUtMDktMjIgMDA6MDE6MDguMDAiLAogICAgInRvdGFsQW1vdW50IjogMjY0Ljk5LAogICAgInBheW1lbnRGb3JtIjogIjAxIiwKICAgICJwYXltZW50TWV0aG9kIjogIlBVRSIsCiAgICAiY3VycmVuY3kiOiAiTVhOIiwKICAgICJ2b3VjaGVyVHlwZSI6ICJJIiwKICAgICJpc3N1ZVBsYWNlIjogIjc3NTAzIiwKICAgICJlbWFpbCI6ICJoYXhpbGFtYUBlamVtcGxvLmNvbSIsCiAgICAiYnJhbmNoS2V5IjogIjEwIiwKICAgICJpdGVtcyI6IFsKICAgICAgICB7CiAgICAgICAgICAgICJwcm9kdWN0U2VydmljZUtleSI6ICI5MDEwMTUwMCIsCiAgICAgICAgICAgICJpdGVtSUQiOiAiMjAyNTEwMTMxNTYxMjM0MDk4NzExMTEwMDAxIiwKICAgICAgICAgICAgInF1YW50aXR5IjogIjEiLAogICAgICAgICAgICAidW5pdEtleSI6ICJFNDgiLAogICAgICAgICAgICAidW5pdE5hbWUiOiAiVW5pZGFkZGVTZXJ2aWNpbyIsCiAgICAgICAgICAgICJkZXNjcmlwdGlvbiI6ICJ4eHhoYXhpbG1hd3VodXd1aHV3dWh1OjEyMzQ1Njc4RmVjaGFkZUNvbnN1bW8yMDI0LTExLTI1MDE6MDI6MDguMDAwIiwKICAgICAgICAgICAgInVuaXRQcmljZSI6IDIyOC40NCwKICAgICAgICAgICAgImFtb3VudCI6IDIyOC40NCwKICAgICAgICAgICAgImRpc2NvdW50IjogMC4wLAogICAgICAgICAgICAidGF4ZXMiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAgICAgICAgICAgICAgInRheFR5cGUiOiAiVCIsCiAgICAgICAgICAgICAgICAgICAgInRheEJhc2UiOiAyMjguNDQsCiAgICAgICAgICAgICAgICAgICAgInRheENvZGUiOiAiMDAyIiwKICAgICAgICAgICAgICAgICAgICAicmF0ZVR5cGUiOiAiVGFzYSIsCiAgICAgICAgICAgICAgICAgICAgInJhdGUiOiAwLjE2LAogICAgICAgICAgICAgICAgICAgICJ0YXhBbW91bnQiOiAzNi41NQogICAgICAgICAgICAgICAgfQogICAgICAgICAgICBdCiAgICAgICAgfQogICAgXQp9
修改于 2026-06-17 10:37:04
上一页
API Common Response Codes
下一页
1.1 Register Tax Ticket
Built with