--- updatedAt: 2025-05-28T00:19:24.000Z agentTools: projectIndex: https://coinify.readme.io/llms.txt --- # Provide Refund Destination This endpoint enables you to provide the destination address for a specific refund. Once the destination address for a refund has been provided, it is not possible to cancel that refund.\ Read more about merchant initiated refunds, their properties, and states [here](https://coinify.readme.io/reference/payment-intent-resource#merchantrefunds). > 📘 Work in progress # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "payment-intent", "version": "1.0" }, "servers": [ { "url": "https://api.payment.sandbox.coinify.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/v1/payment-intents/{paymentIntentId}/refunds/{refundId}/destination": { "patch": { "summary": "Provide Refund Destination", "description": "", "operationId": "provide-refund-address", "parameters": [ { "name": "paymentIntentId", "in": "path", "description": "The PaymentIntent ID", "schema": { "type": "string" }, "required": true }, { "name": "refundId", "in": "path", "description": "The Refund ID", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "address" ], "properties": { "address": { "type": "string", "description": "The address to receive the refund." }, "tag": { "type": "string", "description": "(Optional) A destination tag is used to identify a transaction in order to credit an account. Used only with certain currencies that support tag/memo." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"52e60cc4-e756-4ed2-89eb-6ad8a95ac872\",\n \"orderId\": \"123456\",\n \"state\": \"completed\",\n \"stateReason\": \"completed_exact_amount\",\n \"merchant\": {\n \"id\": \"f3f5c425-caa8-4a63-ba3c-9976f3cbfd80\",\n \"name\": \"Demo Merchant\"\n },\n \"requested\": {\n \"amount\": \"99.99\",\n \"currency\": \"EUR\"\n },\n \"quotes\": [\n {\n \"id\": \"4f7c24b9-019b-4295-bdbd-6066f090cacc\",\n \"amount\": \"0.00511129\",\n \"currency\": \"BTC\",\n \"address\": \"2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM\",\n \"tag\": null,\n \"paymentUri\": \"bitcoin:2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM?amount=0.00511129\",\n \"expirationTime\": \"2022-06-24T10:10:53.965Z\"\n }\n ],\n \"payments\": [\n {\n \"quoteId\": \"4f7c24b9-019b-4295-bdbd-6066f090cacc\",\n \"amount\": \"0.00511129\",\n \"currency\": \"BTC\",\n \"receiverAddress\": \"2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM\",\n \"receiveTime\": \"2022-06-24T09:56:07.250Z\",\n \"confirmTime\": \"2022-06-24T09:56:07.250Z\",\n \"automaticRefund\": null,\n \"transactionId\": \"test-9c8b746f52aa6c081ed91787ffca45ad\"\n }\n ],\n \"merchantRefunds\": [\n {\n \"id\": \"cad7d9be-074a-462a-a3fb-35ab55460ec2\",\n \"state\": \"destination_provided\",\n \"refundCosts\": [\n {\n \"baseAmount\": \"5.27\",\n \"baseCurrency\": \"USD\",\n \"finalAmount\": \"5.27\",\n \"finalCurrency\": \"USD\",\n \"paidBy\": \"merchant\"\n }\n ],\n \"refundAmount\": {\n \"baseAmount\": \"99.99\",\n \"baseCurrency\": \"EUR\",\n \"approximateAmount\": \"0.005010694\",\n \"finalAmount\": \"0.005010694\",\n \"finalCurrency\": \"BTC\"\n },\n \"destination\": {\n \"address\": \"2Mx7j8UcmqGnWAi1Y5E9iU6As2vY3zCFguh\"\n },\n \"transactionId\": null,\n \"createTime\": \"2022-06-24T09:56:17.217Z\",\n \"updateTime\": \"2022-06-24T09:56:17.218Z\"\n }\n ],\n \"redirects\": {\n \"successUrl\": \"https://coinify.com\",\n \"failureUrl\": \"https://www.google.com\"\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "52e60cc4-e756-4ed2-89eb-6ad8a95ac872" }, "orderId": { "type": "string", "example": "123456" }, "state": { "type": "string", "example": "completed" }, "stateReason": { "type": "string", "example": "completed_exact_amount" }, "merchant": { "type": "object", "properties": { "id": { "type": "string", "example": "f3f5c425-caa8-4a63-ba3c-9976f3cbfd80" }, "name": { "type": "string", "example": "Demo Merchant" } } }, "requested": { "type": "object", "properties": { "amount": { "type": "string", "example": "99.99" }, "currency": { "type": "string", "example": "EUR" } } }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "4f7c24b9-019b-4295-bdbd-6066f090cacc" }, "amount": { "type": "string", "example": "0.00511129" }, "currency": { "type": "string", "example": "BTC" }, "address": { "type": "string", "example": "2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM" }, "tag": {}, "paymentUri": { "type": "string", "example": "bitcoin:2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM?amount=0.00511129" }, "expirationTime": { "type": "string", "example": "2022-06-24T10:10:53.965Z" } } } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "quoteId": { "type": "string", "example": "4f7c24b9-019b-4295-bdbd-6066f090cacc" }, "amount": { "type": "string", "example": "0.00511129" }, "currency": { "type": "string", "example": "BTC" }, "receiverAddress": { "type": "string", "example": "2MthHhTErNsf8RKMoQipncm3aXdUZG2qbfM" }, "receiveTime": { "type": "string", "example": "2022-06-24T09:56:07.250Z" }, "confirmTime": { "type": "string", "example": "2022-06-24T09:56:07.250Z" }, "automaticRefund": {}, "transactionId": { "type": "string", "example": "test-9c8b746f52aa6c081ed91787ffca45ad" } } } }, "merchantRefunds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "cad7d9be-074a-462a-a3fb-35ab55460ec2" }, "state": { "type": "string", "example": "destination_provided" }, "refundCosts": { "type": "array", "items": { "type": "object", "properties": { "baseAmount": { "type": "string", "example": "5.27" }, "baseCurrency": { "type": "string", "example": "USD" }, "finalAmount": { "type": "string", "example": "5.27" }, "finalCurrency": { "type": "string", "example": "USD" }, "paidBy": { "type": "string", "example": "merchant" } } } }, "refundAmount": { "type": "object", "properties": { "baseAmount": { "type": "string", "example": "99.99" }, "baseCurrency": { "type": "string", "example": "EUR" }, "approximateAmount": { "type": "string", "example": "0.005010694" }, "finalAmount": { "type": "string", "example": "0.005010694" }, "finalCurrency": { "type": "string", "example": "BTC" } } }, "destination": { "type": "object", "properties": { "address": { "type": "string", "example": "2Mx7j8UcmqGnWAi1Y5E9iU6As2vY3zCFguh" } } }, "transactionId": {}, "createTime": { "type": "string", "example": "2022-06-24T09:56:17.217Z" }, "updateTime": { "type": "string", "example": "2022-06-24T09:56:17.218Z" } } } }, "redirects": { "type": "object", "properties": { "successUrl": { "type": "string", "example": "https://coinify.com" }, "failureUrl": { "type": "string", "example": "https://www.google.com" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"invalid_request\",\n \"errorMessage\": \"A descriptive error message\",\n \"requestId\": \"{requestId}\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "invalid_request" }, "errorMessage": { "type": "string", "example": "A descriptive error message" }, "requestId": { "type": "string", "example": "{requestId}" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"not_found\",\n \"errorMessage\": \"{resource} not found error\",\n \"requestId\": \"{requestId}\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "not_found" }, "errorMessage": { "type": "string", "example": "{resource} not found error" }, "requestId": { "type": "string", "example": "{requestId}" } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"invalid_payload\",\n \"errorMessage\": \"\\\"{property}\\\" is required\",\n \"requestId\": \"{requestId}\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "invalid_payload" }, "errorMessage": { "type": "string", "example": "\"{property}\" is required" }, "requestId": { "type": "string", "example": "{requestId}" } } } } } }, "451": { "description": "451", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"unavailable_legal_reasons\",\n \"errorMessage\": \"Unavailable For Legal Reasons\",\n \"requestId\": \"{requestId}\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "unavailable_legal_reasons" }, "errorMessage": { "type": "string", "example": "Unavailable For Legal Reasons" }, "requestId": { "type": "string", "example": "{requestId}" } } } } } } }, "deprecated": false, "security": [] } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```