Refunds

Obtener datos de devolución de Transaction

Changed on

Devuelve los antecedentes que determinan si una Transaction admite devolución.

Se usa antes de pedir una devolución, para saber si el gateway del pago las acepta, hasta cuándo, y cuánto del pago ya fue devuelto.

Cuando el gateway del pago no admite devoluciones para ese producto, la respuesta llega con gateway_refund_config en null y refund_payment_intents vacío. La configuración también llega deshabilitada cuando el pago se devuelve por lote y la Account no tiene ese flujo activo, o cuando es un pago por transferencia o PAC en Chile y la organización no tiene habilitadas esas devoluciones. El plazo (refund_expiration_days) sale de la política de devoluciones (REFUND_POLICY_CONFIG): la de la organización para pagos con tarjeta de un solo cobro y con wallet, y la por defecto para el resto. Es el del producto del pago cuando su gateway tiene uno propio para él, si no el del gateway. Un gateway sin plazo en la política llega con gateway_refund_config en null.

En los pagos por transferencia o PAC en Chile, la devolución se deposita en la cuenta desde la que pagó el pagador: payer_data_available indica si Toku tiene sus datos.

get/refund/transaction

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/refund/transaction
  • Auth
    API key in header x-api-key

Query parameters

id_transactionstring required

Identificador de la Transaction a consultar.

Example:trs_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O

Response

Successful Response

allows_multiple_partial_refundsboolean required

Indica si la organización y el producto del pago admiten varias devoluciones parciales sobre la misma Invoice.

id_transactionstring required

Identificador de la Transaction consultada.

payer_data_availableboolean required

Indica si Toku tiene los datos de la cuenta de origen del pagador, a la que se deposita la devolución en los pagos por transferencia o PAC en Chile. Cuando llega en false, la devolución será rechazada. En los demás productos siempre llega en true.

refund_in_progress_amountnumber required

Monto de las devoluciones iniciadas que todavía no se cierran. Ya consume saldo del pago aunque aún no figure como devuelto.

refundable_amountnumber required

Saldo del pago que todavía se puede devolver, descontando lo devuelto y lo que está en curso.

refunded_amountnumber required

Monto del pago que ya fue devuelto: suma de las devoluciones cerradas con éxito.

Example response

{
  "id_transaction": "trs_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O",
  "refund_payment_intents": [
    {
      "id_invoice": "in_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O",
      "id_payment_intent": "pi_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O",
      "id_transaction": "trs_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O"
    }
  ]
}

Changes