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

# Add Bank Account Offramp

This endpoint adds a bank account to the offramp transaction. After the customer’s crypto deposit is confirmed, the money will be sent to this bank account.

# 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}/bank_account": {
      "post": {
        "summary": "Add Bank Account Offramp",
        "description": "This endpoint adds a bank account to the offramp transaction. After the customer’s crypto deposit is confirmed, the money will be sent to this bank account.",
        "operationId": "add-bank-account-offramp",
        "parameters": [
          {
            "name": "merchant_reference",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "bank_code": {
                    "type": "string",
                    "description": "Customer's bank code. You can use the banks endpoint to get a list of available banks and their codes."
                  },
                  "account_number": {
                    "type": "string",
                    "description": "Customer's account number. The name on this account must match the name used when initiating the transaction."
                  },
                  "currency_code": {
                    "type": "string",
                    "default": "ngn",
                    "enum": [
                      "ngn",
                      "ghs"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"ok\",\n    \"message\": \"Bank account successfully created and attached to off-ramp transaction\",\n    \"data\": {\n        \"public_id\": \"670553c3-8150-44f4-8524-188b6516363b\",\n        \"metadata\": {\n            \"account_number\": \"8012345678\",\n            \"bank_code\": \"100004\",\n            \"account_name\": \"TEST USER APP\"\n        },\n        \"status\": \"active\",\n        \"created_at\": \"2025-06-25T09:00:02.974Z\",\n        \"updated_at\": \"2025-06-25T09:00:02.974Z\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Bank account successfully created and attached to off-ramp transaction"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "public_id": {
                          "type": "string",
                          "example": "670553c3-8150-44f4-8524-188b6516363b"
                        },
                        "metadata": {
                          "type": "object",
                          "properties": {
                            "account_number": {
                              "type": "string",
                              "example": "8012345678"
                            },
                            "bank_code": {
                              "type": "string",
                              "example": "100004"
                            },
                            "account_name": {
                              "type": "string",
                              "example": "TEST USER APP"
                            }
                          }
                        },
                        "status": {
                          "type": "string",
                          "example": "active"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2025-06-25T09:00:02.974Z"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2025-06-25T09:00:02.974Z"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Failed to create account": {
                    "value": "{\n  \"status\": \"bad_request\", \n  \"message\": \"Failed to create account\",\n  \"data\": null\n}"
                  },
                  "Name does not match": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Name does not match\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Failed to create account",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Failed to create account"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Name does not match",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Name does not match"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6981ba5faf9470ee082aef69"
}
```