Saltar al contenido principal
POST
No ejecutes un reembolso mientras otro está en curso. Espera a que la operación actual termine antes de iniciar una nueva.
Este servicio te permite cancelar o reembolsar un pago existente. Nuestro sistema identificará si es necesaria una cancelación o un reembolso según el pago, en este caso no se necesita un transaction_id. Este servicio realiza las siguientes funciones según el estado de la transacción:
  • Cancela el pago si no ha sido capturado.
  • Reembolsa el pago si ha sido capturado.
ReembolsosSi completas el campo amount, el reembolso será parcial. De lo contrario, se creará un reembolso completo. Los fondos se reembolsarán al método de pago que se cargó originalmente.La respuesta devuelve una transacción REFUND con su propio status: SUCCEEDED cuando el reembolso es aprobado, o PENDING mientras el proveedor lo confirma. REFUNDED es un estado del pago, no de una transacción. Después de que un reembolso completo es exitoso, el status y el sub_status del pago son REFUNDED.
Pagos con una promoción de YunoUn reembolso se calcula sobre lo que pagó el cliente, amount.value menos discount_amount. Un reembolso completo devuelve ese monto, y un amount superior a lo que queda por reembolsar se rechaza con 400 INVALID_PARAMETERS. Cancelar anula la autorización por ese monto. Consulta Promotions.
Pagos aprobados parcialmentePara un pago con tarjeta enviado con payment_method.detail.card.partial_approval: true y aprobado por menos de lo solicitado, los reembolsos se limitan a amount.authorized. Un reembolso completo devuelve amount.authorized, y un amount superior a lo que queda de ese monto se rechaza con 400 INVALID_PARAMETERS.
Ten en cuenta que esta solicitud requiere un X-Idempotency-Key. Consulta la página Authentication para obtener más información.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido
X-Idempotency-Key
string
header
predeterminado:<Your X-Idempotency-Key>
requerido

Parámetros de ruta

payment_id
string
requerido

El identificador único del pago (UUID, 36 caracteres).

Cuerpo

application/json
reason
enum<string>
requerido

Indica el motivo de la cancelación o del reembolso. Si se define, los valores posibles son DUPLICATE, FRAUDULENT, REQUESTED_BY_CUSTOMER y REVERSE. Usa REVERSE para solicitar una reversión automática de los fondos del destinatario cuando hay un destinatario involucrado en la transacción.

Opciones disponibles:
DUPLICATE,
FRAUDULENT,
REQUESTED_BY_CUSTOMER,
REVERSE
description
string

Descripción de la cancelación o del reembolso. (MAX 255; MIN 3).

merchant_reference
string

Identificación de la transacción de pago definida por el comercio. Si no se define merchant_reference, se asocia a la transacción el merchant_order_id del pago. (MAX 255; MIN 3).

amount
object

Especifica el objeto de monto para el reembolso.

split_marketplace
object[]

Array de objetos de split marketplace

simplified_mode
boolean
predeterminado:false

Indica si se debe intentar reembolsar un pago después de un error o rechazo en el primer intento. Por defecto es false. Para más información, accede a la guía [blocked].

response_additional_data
object

Especifica datos adicionales requeridos para la respuesta de la transacción

customer_payer
object

Indica el objeto customer de los pagos.

payment_method
object

Especifica el objeto de método de pago para los pagos.

Respuesta

201

id
string
Ejemplo:

"7fd485f3-bd72-45eb-a3fb-774daa3d79b6"

type
string
Ejemplo:

"REFUND"

status
string
Ejemplo:

"SUCCEEDED"

category
string
Ejemplo:

"CARD"

amount
object
merchant_reference
string
Ejemplo:

"0000023"

created_at
string
Ejemplo:

"2024-06-06T14:06:06.284443Z"

updated_at
string
Ejemplo:

"2024-06-06T14:06:37.984065Z"

provider_data
object
connection_data
object
response_code
string
Ejemplo:

"SUCCEEDED"

response_message
string
Ejemplo:

"Transaction successful"

payment
object
customer_payer
object

Pagador cliente.

simplified_mode
boolean

Modo simplificado.

Ejemplo:

false

receipt
boolean

Comprobante.

Ejemplo:

false

receipt_url
any | null

URL del comprobante.

receipt_language
any | null

Idioma del comprobante.

split_marketplace
any[]

Split marketplace.

metadata
any | null

Metadata.