> ## Documentation Index > Fetch the complete documentation index at: https://cobo.com/payments/llms.txt > Use this file to discover all available pages before exploring further. # Create refund link > This operation creates a link that points to a Cobo-hosted refund page. The user can submit their desired refund address on the page. Once the address is submitted, Cobo will automatically create a refund order and initiate the refund process according to your configuration. For details, see [Create refund link](https://www.cobo.com/payments/en/guides/create-refund-link). ```python Python theme={null} import cobo_waas2 from cobo_waas2.models.create_refund_link_request import CreateRefundLinkRequest from cobo_waas2.models.link import Link from cobo_waas2.rest import ApiException from pprint import pprint # See configuration.py for a list of all supported configurations. configuration = cobo_waas2.Configuration( # Replace `` with your private key api_private_key="", # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. host="https://api.dev.cobo.com/v2", ) # Enter a context with an instance of the API client with cobo_waas2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = cobo_waas2.PaymentApi(api_client) create_refund_link_request = cobo_waas2.CreateRefundLinkRequest( business_info=cobo_waas2.RefundLinkBusinessInfo( transaction_id="aff0e1cb-15b2-4e1f-9b9d-a9133715986f", amount="0.0025", refund_source="Merchant", ) ) try: # Create refund link api_response = api_instance.create_refund_link( create_refund_link_request=create_refund_link_request ) print("The response of PaymentApi->create_refund_link:\n") pprint(api_response) except Exception as e: print("Exception when calling PaymentApi->create_refund_link: %s\n" % e) ``` ```java Java theme={null} // Import classes: import com.cobo.waas2.ApiClient; import com.cobo.waas2.ApiException; import com.cobo.waas2.Configuration; import com.cobo.waas2.Env; import com.cobo.waas2.api.PaymentApi; import com.cobo.waas2.model.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Select the development environment. To use the production environment, replace `Env.DEV` with // `Env.PROD defaultClient.setEnv(Env.DEV); // Replace `` with your private key defaultClient.setPrivKey(""); PaymentApi apiInstance = new PaymentApi(); CreateRefundLinkRequest createRefundLinkRequest = new CreateRefundLinkRequest() .businessInfo( new RefundLinkBusinessInfo() .transactionId("aff0e1cb-15b2-4e1f-9b9d-a9133715986f") .amount("0.0025") .refundSource(RefundType.MERCHANT)); try { Link result = apiInstance.createRefundLink(createRefundLinkRequest); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PaymentApi#createRefundLink"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ```go Go theme={null} package main import ( "context" "fmt" coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2" "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto" "os" ) func main() { createRefundLinkRequest := *coboWaas2.NewCreateRefundLinkRequest(*coboWaas2.NewRefundLinkBusinessInfo("aff0e1cb-15b2-4e1f-9b9d-a9133715986f", "0.0025", coboWaas2.RefundType("Merchant"))) configuration := coboWaas2.NewConfiguration() // Initialize the API client apiClient := coboWaas2.NewAPIClient(configuration) ctx := context.Background() // Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv) // Replace `` with your private key ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{ Secret: "", }) resp, r, err := apiClient.PaymentAPI.CreateRefundLink(ctx). CreateRefundLinkRequest(createRefundLinkRequest). Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreateRefundLink``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `CreateRefundLink`: Link fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreateRefundLink`: %v\n", resp) } ``` ```javascript JavaScript theme={null} const CoboWaas2 = require("@cobo/cobo-waas2"); // Initialize the API client const apiClient = CoboWaas2.ApiClient.instance; // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD` apiClient.setEnv(CoboWaas2.Env.DEV); // Replace `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.PaymentApi(); const opts = { CreateRefundLinkRequest: CoboWaas2.CreateRefundLinkRequest.constructFromObject({ business_info: { transaction_id: "aff0e1cb-15b2-4e1f-9b9d-a9133715986f", amount: "0.0025", refund_source: "Merchant", }, }), }; apiInstance.createRefundLink(opts).then( (data) => { console.log("API called successfully. Returned data: " + data); }, (error) => { console.error(error); }, ); ``` ## OpenAPI ````yaml post /payments/links/refunds openapi: 3.0.3 info: title: Cobo Wallet as a Service 2.0 description: > The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features: - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). termsOfService: https://cobo.com/waas/tos/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: name: Cobo WaaS url: https://www.cobo.com/waas email: help@cobo.com version: 1.0.0 servers: - url: https://api.dev.cobo.com/v2 description: Development environment - url: https://api.cobo.com/v2 description: Production environment security: - CoboAuth: [] tags: - name: Organizations description: Operations related to Organizations. - name: Wallets description: Operations related to all wallets. - name: Wallets - MPC Wallets description: Operations related to mpc wallet. - name: Wallets - Exchange Wallet description: Operations related to exchange wallet. - name: Wallets - Smart Contract Wallets description: Operations related to smart contract wallet. - name: Transactions description: Operations related to all transactions. - name: Developers - Webhooks description: Operations related to webhooks. - name: Stakings description: Operations related to staking. - name: OAuth description: Operations related to OAuth. - name: Developers description: Operations related to developers. - name: AddressBooks description: Operations related to address books. - name: TravelRule description: Operations related to travel rule. - name: GraphQL description: Operations related to executing GraphQL queries and mutations. - name: PrimeBroker description: Operations related to prime broker. - name: AppWorkflows description: Operations related to app workflow. - name: FeeStation description: Operations related to fee station. - name: Payment description: Operations related to payment. - name: Batch Payouts description: Operations related to batch payouts. - name: Tokenization description: Operations related to tokenization. - name: AutoSweep description: Operations related to auto sweep. - name: Compliance description: Operations related to compliance. paths: /payments/links/refunds: post: tags: - Payment summary: Create refund link description: > This operation creates a link that points to a Cobo-hosted refund page. The user can submit their desired refund address on the page. Once the address is submitted, Cobo will automatically create a refund order and initiate the refund process according to your configuration. For details, see [Create refund link](https://www.cobo.com/payments/en/guides/create-refund-link). operationId: create_refund_link requestBody: $ref: '#/components/requestBodies/createPaymentRefundLinkRequest' responses: '201': $ref: '#/components/responses/createPaymentLinkResponse' 4XX: $ref: '#/components/responses/badRequestError' 5XX: $ref: '#/components/responses/internalServerError' components: requestBodies: createPaymentRefundLinkRequest: description: The request body to create a refund link. content: application/json: schema: type: object required: - business_info properties: business_info: $ref: '#/components/schemas/RefundLinkBusinessInfo' display_info: $ref: '#/components/schemas/LinkDisplayInfo' responses: createPaymentLinkResponse: description: Link created successfully. content: application/json: schema: $ref: '#/components/schemas/Link' badRequestError: description: >- Bad request. Your request contains malformed syntax or invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' internalServerError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: RefundLinkBusinessInfo: type: object required: - amount - refund_source properties: order_id: type: string description: > The id of the order to refund. Specify either `order_id` or `transaction_id`, but not both. example: O20250304-M1001-1001 transaction_id: type: string description: > The transaction ID of the original order payment or top-up. Specify either `order_id` or `transaction_id`, but not both. On the refund page, the from address of this transaction will be pre-filled as the default refund address. The refund will be processed in the same token and on the same blockchain as this transaction. example: aff0e1cb-15b2-4e1f-9b9d-a9133715986f amount: type: string description: >- The amount to refund, denominated in the cryptocurrency of the original payment transaction. The amount must be a positive number and can have up to two decimal places. example: '0.0025' refund_source: $ref: '#/components/schemas/RefundType' merchant_id: type: string description: >- The merchant ID, required if `refund_source` is `Merchant`. The fund will be deducted from the specified merchant's balance. example: M1001 fee_amount: type: string description: > The developer fee amount to charge the merchant, denominated in the cryptocurrency of the original payment transaction. This field is only valid when `refund_source` is `Merchant`. For more information, please refer to [Accounts and fund allocation](https://www.cobo.com/payments/en/guides/amounts-and-balances). Must be: - A positive integer with up to two decimal places. - Less than the refund amount example: '0.0001' LinkDisplayInfo: type: object properties: developer_name: type: string description: > The brand name to display to end users on the page. This helps users identify who is providing the payment service. example: Acme Payment Solutions maxLength: 128 logo: type: string description: | The URL of the logo image to display to end users on the page. example: https://example.com/logo.png format: uri return_url: type: string description: > The product page URL where end users will be redirected after the payment process ends. This URL is embedded in a "Return to Merchant" button displayed on the following result pages: - Payment success - Payment timeout - Payment rejected - Payment error example: https://example.com/return format: uri Link: type: object required: - url - token properties: url: type: string format: uri description: > The base URL of the page. This URL should be combined with the `token` parameter to form the complete link. example: https://payment-link.dev.cobo.com/payment token: type: string description: > The token appended to the URL as a query parameter. This token identifies and authenticates a specific payment or refund session. The complete link should be constructed as: `[url]?token=[token]` example: 01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF ErrorResponse: type: object description: The response of a failed request. required: - error_code - error_message - error_id properties: error_code: type: integer description: >- The error code. Refer to [Error codes and status codes](https://www.cobo.com/developers/v2/api-references/error-codes) for more details. error_message: type: string description: The error description. error_id: type: string description: >- The error log ID. You can provide the error ID when submitting a ticket to help Cobo to locate the issue. example: 0b6ddf19083c4bd1a9ca01bec44b24dd RefundType: type: string enum: - Merchant - Psp example: Merchant description: > Specifies the source of funds for the refund: - `Merchant`: The refund amount will be deducted from the merchant balance. - `Psp`: The refund amount will be deducted from the developer balance. securitySchemes: CoboAuth: type: apiKey in: header name: BIZ-API-KEY description: > The API key. For more details, refer to [API key](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-key). In the API playground, enter your [API secret](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-secret), and your API key will be accordingly calculated. ````