> ## Documentation Index > Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Refund Detail > Get detailed information about a specific refund. ## OpenAPI ````yaml get /refunds/{refund_id} openapi: 3.1.0 info: title: public description: '' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.118.3 servers: - url: https://test.dodopayments.com/ description: Test Mode Server Host - url: https://live.dodopayments.com/ description: Live Mode Server Host security: [] tags: - name: Products - name: Payments - name: Subscriptions - name: Addons - name: Customers - name: Refunds - name: Disputes - name: Events - name: License Keys - name: Entitlements - name: Licenses - name: Discounts - name: Meters - name: Credit Entitlements - name: Credit Entitlement Balances - name: Outgoing Webhooks - name: Checkout - name: Webhook Events - name: Payment Connector Webhooks - name: Moderation paths: /refunds/{refund_id}: get: tags: - Refunds operationId: get_refund_handler parameters: - name: refund_id in: path description: Refund Id required: true schema: type: string example: ref_F0gZetLvTxxBrMU2CZcmy responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RefundResponse' '500': description: Something went wrong :( security: - API_KEY: [] x-codeSamples: - lang: JavaScript source: >- 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); - lang: Python source: |- import os from dodopayments import DodoPayments client = DodoPayments( bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted ) refund = client.refunds.retrieve( "ref_F0gZetLvTxxBrMU2CZcmy", ) print(refund.brand_id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/dodopayments/dodopayments-go\"\n\t\"github.com/dodopayments/dodopayments-go/option\"\n)\n\nfunc main() {\n\tclient := dodopayments.NewClient(\n\t\toption.WithBearerToken(\"My Bearer Token\"),\n\t)\n\trefund, err := client.Refunds.Get(context.TODO(), \"ref_F0gZetLvTxxBrMU2CZcmy\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", refund.BrandID)\n}\n" - lang: Java source: |- package com.dodopayments.api.example; import com.dodopayments.api.client.DodoPaymentsClient; import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient; import com.dodopayments.api.models.refunds.Refund; import com.dodopayments.api.models.refunds.RefundRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv(); Refund refund = client.refunds().retrieve("ref_F0gZetLvTxxBrMU2CZcmy"); } } - lang: Kotlin source: |- package com.dodopayments.api.example import com.dodopayments.api.client.DodoPaymentsClient import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient import com.dodopayments.api.models.refunds.Refund import com.dodopayments.api.models.refunds.RefundRetrieveParams fun main() { val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv() val refund: Refund = client.refunds().retrieve("ref_F0gZetLvTxxBrMU2CZcmy") } - lang: Ruby source: |- require "dodopayments" dodo_payments = Dodopayments::Client.new( bearer_token: "My Bearer Token", environment: "test_mode" # defaults to "live_mode" ) refund = dodo_payments.refunds.retrieve("ref_F0gZetLvTxxBrMU2CZcmy") puts(refund) - lang: PHP source: |- refunds->retrieve('ref_F0gZetLvTxxBrMU2CZcmy'); var_dump($refund); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: |- using System; using DodoPayments.Client; using DodoPayments.Client.Models.Refunds; DodoPaymentsClient client = new(); RefundRetrieveParams parameters = new() { RefundID = "ref_F0gZetLvTxxBrMU2CZcmy" }; var refund = await client.Refunds.Retrieve(parameters); Console.WriteLine(refund); - lang: Rust source: |- use dodopayments::Client; #[tokio::main] async fn main() -> dodopayments::Result<()> { let client = Client::from_env()?; let refund_id = "refund_id"; let result = client .refunds() .retrieve() .refund_id(refund_id) .await?; println!("{result:?}"); Ok(()) } components: schemas: RefundResponse: type: object required: - refund_id - payment_id - business_id - status - created_at - is_partial - metadata - customer - brand_id properties: amount: type: - integer - 'null' format: int32 description: The refunded amount. brand_id: type: string description: Brand id this refund belongs to business_id: type: string description: The unique identifier of the business issuing the refund. created_at: type: string format: date-time description: The timestamp of when the refund was created in UTC. currency: oneOf: - type: 'null' - $ref: '#/components/schemas/Currency' description: >- The currency of the refund, represented as an ISO 4217 currency code. customer: $ref: '#/components/schemas/CustomerLimitedDetailsResponse' description: >- Details about the customer for this refund (from the associated payment) is_partial: type: boolean description: If true the refund is a partial refund metadata: $ref: '#/components/schemas/Metadata' description: Additional metadata stored with the refund. network_reference: type: - string - 'null' description: >- 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: oneOf: - type: 'null' - $ref: '#/components/schemas/RefundNetworkReferenceType' description: 'The kind of `network_reference`: ARN, STAN or RRN.' payment_id: type: string description: The unique identifier of the payment associated with the refund. reason: type: - string - 'null' description: The reason provided for the refund, if any. Optional. refund_id: type: string description: The unique identifier of the refund. status: $ref: '#/components/schemas/RefundStatus' description: The current status of the refund. Currency: type: string enum: - 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 CustomerLimitedDetailsResponse: type: object required: - customer_id - name - email properties: customer_id: type: string description: Unique identifier for the customer email: type: string description: Email address of the customer metadata: $ref: '#/components/schemas/Metadata' description: Additional metadata associated with the customer name: type: string description: Full name of the customer phone_number: type: - string - 'null' description: Phone number of the customer Metadata: type: object title: Metadata description: >- Arbitrary key-value metadata. Values can be string, integer, number, or boolean. additionalProperties: oneOf: - type: string title: String - type: integer title: Integer format: int64 - type: number title: Number format: double - type: boolean title: Boolean title: Metadata Value description: Metadata value can be a string, integer, number, or boolean RefundNetworkReferenceType: type: string description: >- The kind of reference number that the card network or the bank gives to a refund. enum: - acquirer_reference_number - system_trace_audit_number - retrieval_reference_number - other RefundStatus: type: string enum: - succeeded - failed - pending - review securitySchemes: API_KEY: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.