Dispersiones

Obtener dispersiones

GET /v1/payouts

Este endpoint devuelve las dispersiones de los comercios de un cliente en un rango de fechas, de forma paginada. Disponible con credenciales CUSTOMER; con credenciales MERCHANT la respuesta es 403.

Datos de consulta

ParámetrosDescripción
start
  • date
  • La fecha de inicio del rango de búsqueda
  • [yyyy-MM-dd]
end
  • date
  • La fecha de fin del rango de búsqueda
  • [yyyy-MM-dd]
page
  • integer
  • El número de la página de resultados a obtener (>=0)
size
  • integer
  • El número de resultados por página (max = 10000)
merchantId
  • (opcional)
  • array
  • Identificadores (UUID) de comercio para acotar la búsqueda
acquirerId
  • (opcional)
  • string
  • Identificador del adquirente
country
  • (opcional)
  • string
  • Filtra por país

Datos de respuesta

Cada elemento de content es una dispersión. Los campos sin valor se omiten.

ParámetrosDescripción
customer_id
  • (opcional)
  • string
  • Identificador del cliente
merchant_id
  • (opcional)
  • string
  • Identificador del comercio
acquirer
  • (opcional)
  • string
  • Adquirente
merchant_additional_info
  • (opcional)
  • string
  • Información adicional del comercio
country
  • (opcional)
  • string
  • País
currency
  • (opcional)
  • string
  • Moneda
payment_date
  • (opcional)
  • string
  • Fecha de pago
pending_amount
  • (opcional)
  • number
  • Monto pendiente de pago
paid_amount
  • (opcional)
  • number
  • Monto pagado
settlement_id
  • (opcional)
  • string
  • Identificador de la liquidación
detail
  • (opcional)
  • object
  • Datos del cliente y del comercio
  • detail.
customer_name
  • (opcional)
  • string
  • Nombre del cliente
  • detail.
merchant_name
  • (opcional)
  • string
  • Nombre del comercio
  • detail.
business_name
  • (opcional)
  • string
  • Razón social
  • detail.
document_type
  • (opcional)
  • string
  • Tipo de documento
  • detail.
document_number
  • (opcional)
  • string
  • Número de documento
  • detail.
bank_account_number
  • (opcional)
  • string
  • Número de cuenta bancaria
tax_info
  • object
  • Información de impuestos
  • tax_info.
gross_amount
  • (opcional)
  • number
  • Monto bruto
  • tax_info.
net_amount
  • (opcional)
  • number
  • Monto neto
  • tax_info.
tax_breakdown
  • array
  • Desglose de impuestos
  • tax_info.tax_breakdown.
tax_code
  • string
  • Código de impuesto
  • tax_info.tax_breakdown.
reference
  • string
  • Descripción del impuesto
  • tax_info.tax_breakdown.
amount
  • number
  • Monto del impuesto
  • tax_info.tax_breakdown.
rate
  • (opcional)
  • number
  • Tasa del impuesto
  curl --request GET \
    --url 'https://api.menta.global/api/v1/payouts' \
    --header 'Authorization: Bearer {access_token}' \
    --url-query 'start=string' \
    --url-query 'end=string' \
    --url-query 'page=integer' \
    --url-query 'size=integer'
  {
    "content": [
      {
        "customer_id": "string",
        "merchant_id": "string",
        "acquirer": "string",
        "merchant_additional_info": "string",
        "country": "string",
        "currency": "string",
        "payment_date": "2023-11-14",
        "pending_amount": 0,
        "paid_amount": 0,
        "settlement_id": "string",
        "detail": {
          "customer_name": "string",
          "merchant_name": "string",
          "business_name": "string",
          "document_type": "string",
          "document_number": "string",
          "bank_account_number": "string"
        },
        "tax_info": {
          "gross_amount": 0,
          "net_amount": 0,
          "tax_breakdown": [
            {
              "tax_code": "string",
              "reference": "string",
              "amount": 0,
              "rate": 0
            }
          ]
        }
      }
    ],
    "pageable": {
      "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
      },
      "page_number": 0,
      "page_size": 0,
      "offset": 0,
      "paged": true,
      "unpaged": true
    },
    "total_pages": 0,
    "total_elements": 0
  }
Operaciones por mesDispersiones en CSV