Mercado Pago Payments API

The Payments API from Mercado Pago — 4 operation(s) for payments.

OpenAPI Specification

mercadopago-payments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Mercado Pago REST Payments API
  description: 'Mercado Pago REST API covering payments, Checkout Pro preferences, and

    subscriptions (preapprovals). All requests authenticate with a Bearer access

    token in the Authorization header.

    '
  version: v1
  contact:
    name: Mercado Pago Developers
    url: https://www.mercadopago.com.ar/developers/en/reference
servers:
- url: https://api.mercadopago.com
  description: Mercado Pago production API
security:
- bearerAuth: []
tags:
- name: Payments
paths:
  /v1/payments:
    post:
      tags:
      - Payments
      summary: Create a payment
      responses:
        '201':
          description: Payment created
  /v1/payments/search:
    get:
      tags:
      - Payments
      summary: Search payments
      parameters:
      - name: status
        in: query
        schema:
          type: string
      - name: external_reference
        in: query
        schema:
          type: string
      - name: range
        in: query
        schema:
          type: string
      - name: begin_date
        in: query
        schema:
          type: string
      - name: end_date
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Search results
  /v1/payments/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: integer
    get:
      tags:
      - Payments
      summary: Get a payment
      responses:
        '200':
          description: Payment
    put:
      tags:
      - Payments
      summary: Update a payment (capture, cancel, refund metadata)
      responses:
        '200':
          description: Updated payment
  /v1/payments/{id}/refunds:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: integer
    post:
      tags:
      - Payments
      summary: Refund a payment
      responses:
        '201':
          description: Refund created
    get:
      tags:
      - Payments
      summary: List refunds for a payment
      responses:
        '200':
          description: Refunds list
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: access_token
      description: 'Mercado Pago access token (ENV_ACCESS_TOKEN). Send as

        "Authorization: Bearer {ACCESS_TOKEN}". HTTPS is required.

        '