EBANX · Schema

EBANX Refund

A refund issued against a confirmed EBANX payment.

PaymentsPay-inPayoutsForeign ExchangeTokenizationLATAMEmerging MarketsPixBoletoOXXOSPEIPSECross-BorderWebhooks

Properties

Name	Type	Description
id	string	EBANX refund identifier.
merchant_refund_code	string	Merchant-provided refund identifier.
payment_hash	string	EBANX payment hash being refunded.
status	string	Refund status: RE requested, PE pending, CO confirmed, CA cancelled.
amount_ext	number
currency_ext	string
description	string
operation_date	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ebanx/main/json-schema/ebanx-refund-schema.json",
  "title": "EBANX Refund",
  "description": "A refund issued against a confirmed EBANX payment.",
  "type": "object",
  "required": ["id", "status", "amount_ext"],
  "properties": {
    "id": { "type": "string", "description": "EBANX refund identifier." },
    "merchant_refund_code": { "type": "string", "description": "Merchant-provided refund identifier." },
    "payment_hash": { "type": "string", "description": "EBANX payment hash being refunded." },
    "status": { "type": "string", "enum": ["RE", "PE", "CO", "CA"], "description": "Refund status: RE requested, PE pending, CO confirmed, CA cancelled." },
    "amount_ext": { "type": "number" },
    "currency_ext": { "type": "string" },
    "description": { "type": "string" },
    "operation_date": { "type": "string", "format": "date" }
  }
}