---
agentTools:
  projectIndex: https://docs.quidax.io/llms.txt
---

# Refresh Off Ramp Transaction

This endpoints refreshes the off ramp transaction.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Ramp Merchant API",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://ramp-be.quidax.io/api/v1/merchants/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "x-private-key",
        "in": "header",
        "x-default": "secret_key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/custodial/off_ramp_transactions/{merchant_reference}/refresh": {
      "put": {
        "summary": "Refresh Off Ramp Transaction",
        "description": "This endpoints refreshes the off ramp transaction.",
        "operationId": "refresh-off-ramp-transaction",
        "parameters": [
          {
            "name": "merchant_reference",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "from_currency": {
                    "type": "string",
                    "default": "usdt",
                    "enum": [
                      "usdt",
                      "usdc"
                    ]
                  },
                  "to_currency": {
                    "type": "string",
                    "default": "ngn",
                    "enum": [
                      "ngn",
                      "ghs"
                    ]
                  },
                  "from_amount": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"ok\",\n    \"message\": \"Transaction successfully refreshed\",\n    \"data\": {\n        \"public_id\": \"fec8c99e-7b1b-49cf-8257-02fc87736b89\",\n        \"from_currency\": \"USDT\",\n        \"to_currency\": \"NGN\",\n        \"to_amount\": \"3126.47\",\n        \"from_amount\": \"2.0\",\n        \"reference\": \"TRX-C4IOD1MGD8\",\n        \"merchant_reference\": \"tx123bb45-ramp-12221-test21o\",\n        \"status\": \"pending\",\n        \"created_at\": \"2025-06-16T09:32:06.966Z\",\n        \"updated_at\": \"2025-06-16T10:27:50.113Z\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction successfully refreshed"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "public_id": {
                          "type": "string",
                          "example": "fec8c99e-7b1b-49cf-8257-02fc87736b89"
                        },
                        "from_currency": {
                          "type": "string",
                          "example": "USDT"
                        },
                        "to_currency": {
                          "type": "string",
                          "example": "NGN"
                        },
                        "to_amount": {
                          "type": "string",
                          "example": "3126.47"
                        },
                        "from_amount": {
                          "type": "string",
                          "example": "2.0"
                        },
                        "reference": {
                          "type": "string",
                          "example": "TRX-C4IOD1MGD8"
                        },
                        "merchant_reference": {
                          "type": "string",
                          "example": "tx123bb45-ramp-12221-test21o"
                        },
                        "status": {
                          "type": "string",
                          "example": "pending"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2025-06-16T09:32:06.966Z"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2025-06-16T10:27:50.113Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Currency swap not allowed": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Currency swap not allowed: usdt -> ngnk\",\n  \"data\": null\n}"
                  },
                  "Failed to refresh off-ramp transaction": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Failed to refresh off-ramp transaction\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Currency swap not allowed",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Currency swap not allowed: usdt -> ngnk"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Failed to refresh off-ramp transaction",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Failed to refresh off-ramp transaction"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:698ed24be74b3cfc4b2bf8f5"
}
```