Obtener Detalle de Reembolso

Obtener información detallada sobre un reembolso específico.

GET /refunds/{refund_id}

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const refund = await client.refunds.retrieve('ref_F0gZetLvTxxBrMU2CZcmy');

console.log(refund.brand_id);

200

{
  "brand_id": "<string>",
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "customer_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "metadata": {},
    "phone_number": "<string>"
  },
  "is_partial": true,
  "metadata": {},
  "payment_id": "<string>",
  "refund_id": "<string>",
  "status": "succeeded",
  "amount": 123,
  "currency": "AED",
  "network_reference": "<string>",
  "network_reference_type": "acquirer_reference_number",
  "network_reference_updated_at": "2023-11-07T05:31:56Z",
  "reason": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

refund_id · string · requerido

Refund Id

Respuesta

200

application/json

brand_id · string · requerido

Brand id this refund belongs to

business_id · string · requerido

The unique identifier of the business issuing the refund.

created_at · string<date-time> · requerido

The timestamp of when the refund was created in UTC.

customer · object · requerido

Details about the customer for this refund (from the associated payment)

Show child attributes

is_partial · boolean · requerido

If true the refund is a partial refund

metadata · Metadata · object · requerido

Additional metadata stored with the refund.

Show child attributes

payment_id · string · requerido

The unique identifier of the payment associated with the refund.

refund_id · string · requerido

The unique identifier of the refund.

status · enum<string> · requerido

The current status of the refund.

Opciones disponibles: succeeded, failed, pending, review

amount · integer<int32> | null

The refunded amount.

currency · null | enum<string>

The currency of the refund, represented as an ISO 4217 currency code.

Opciones disponibles: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW

network_reference · string | null

The reference number that the card network or the bank gives to the refund. The customer can give this number to their bank to trace the refund. It is null until the reference is available.

network_reference_type · null | enum<string>

The kind of network_reference: ARN, STAN or RRN.

Opciones disponibles: acquirer_reference_number, system_trace_audit_number, retrieval_reference_number, other

network_reference_updated_at · string<date-time> | null

The time in UTC when network_reference became available. It is null when the reference is not available, or when it became available before this field existed.

reason · string | null

The reason provided for the refund, if any. Optional.