Mercado Pago · Schema

Mercado Pago Payment

JSON Schema for a Mercado Pago Payment resource.

PaymentsCheckoutSubscriptionsPOSQRPIXSDKsWalletAcquiringLendingIssuingLatin AmericaBrazilArgentinaMexicoChileColombiaPeruUruguayFintech

Properties

Name	Type	Description
id	integer
date_created	string
date_approved	stringnull
date_last_updated	string
money_release_date	stringnull
status	string
status_detail	string
currency_id	string
description	string
transaction_amount	number
transaction_amount_refunded	number
payment_method_id	string
payment_type_id	string
installments	integer
external_reference	string
payer	object
metadata	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mercado-pago/refs/heads/main/json-schema/mercado-pago-payment-schema.json",
  "title": "Mercado Pago Payment",
  "description": "JSON Schema for a Mercado Pago Payment resource.",
  "type": "object",
  "required": ["id", "status", "currency_id", "transaction_amount", "payment_method_id", "payment_type_id"],
  "properties": {
    "id": { "type": "integer", "format": "int64" },
    "date_created": { "type": "string", "format": "date-time" },
    "date_approved": { "type": ["string", "null"], "format": "date-time" },
    "date_last_updated": { "type": "string", "format": "date-time" },
    "money_release_date": { "type": ["string", "null"], "format": "date-time" },
    "status": {
      "type": "string",
      "enum": ["pending", "approved", "authorized", "in_process", "in_mediation", "rejected", "cancelled", "refunded", "charged_back"]
    },
    "status_detail": { "type": "string" },
    "currency_id": { "type": "string", "examples": ["BRL", "ARS", "MXN", "CLP", "COP", "PEN", "UYU"] },
    "description": { "type": "string" },
    "transaction_amount": { "type": "number", "minimum": 0 },
    "transaction_amount_refunded": { "type": "number", "minimum": 0 },
    "payment_method_id": { "type": "string", "examples": ["visa", "master", "pix", "bolbradesco", "oxxo", "pse"] },
    "payment_type_id": {
      "type": "string",
      "enum": ["credit_card", "debit_card", "ticket", "bank_transfer", "atm", "account_money", "digital_currency", "digital_wallet", "prepaid_card"]
    },
    "installments": { "type": "integer", "minimum": 1 },
    "external_reference": { "type": "string" },
    "payer": { "$ref": "#/$defs/Payer" },
    "metadata": { "type": "object", "additionalProperties": true }
  },
  "$defs": {
    "Payer": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "email": { "type": "string", "format": "email" },
        "first_name": { "type": "string" },
        "last_name": { "type": "string" },
        "identification": {
          "type": "object",
          "properties": {
            "type": { "type": "string" },
            "number": { "type": "string" }
          }
        }
      }
    }
  }
}