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

# Verify a bank account

Checks that a bank account is valid and returns the account holder’s name.

# 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": {
    "/refunds/{merchant_reference}/verify_account": {
      "post": {
        "summary": "Verify a bank account",
        "description": "Checks that a bank account is valid and returns the account holder’s name.",
        "operationId": "verify-a-bank-account",
        "parameters": [
          {
            "name": "merchant_reference",
            "in": "path",
            "description": "The merchant reference of the original transaction. The transaction must belong to the merchant making the request.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "account_number": {
                    "type": "string",
                    "description": "The bank account number that will receive the refund. It cannot be empty."
                  },
                  "bank_code": {
                    "type": "string",
                    "description": "The code that identifies the bank. It cannot be empty."
                  },
                  "currency_code": {
                    "type": "string",
                    "description": "The currency used to verify the account. If it is not provided, the API uses ngn."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"ok\",\n  \"message\": \"Bank account successfully verified\",\n  \"data\": {\n    \"account_name\": \"Ada Lovelace\",\n    \"account_number\": \"0123456789\",\n    \"bank_name\": \"GTBank\",\n    \"bank_code\": \"058\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Bank account successfully verified"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "account_name": {
                          "type": "string",
                          "example": "Ada Lovelace"
                        },
                        "account_number": {
                          "type": "string",
                          "example": "0123456789"
                        },
                        "bank_name": {
                          "type": "string",
                          "example": "GTBank"
                        },
                        "bank_code": {
                          "type": "string",
                          "example": "058"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Bad Request — Invalid request fields": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"account_number is missing, bank_code must be filled\",\n  \"data\": null\n}"
                  },
                  "Bad Request — Bank not found": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Bank not found\",\n  \"data\": null\n}"
                  },
                  "Bad Request — Account number required": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Account number is required\",\n  \"data\": null\n}"
                  },
                  "Bad Request — Invalid currency": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Invalid Currency\",\n  \"data\": null\n}"
                  },
                  "Bad Request — Account could not be verified": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Failed to resolve bank account\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Bad Request — Invalid request fields",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "account_number is missing, bank_code must be filled"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Bad Request — Bank not found",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Bank not found"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Bad Request — Account number required",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Account number is required"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Bad Request — Invalid currency",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid Currency"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Bad Request — Account could not be verified",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Failed to resolve bank account"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Not Found — Transaction not found": {
                    "value": "{\n  \"status\": \"not_found\",\n  \"message\": \"Transaction not found\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "not_found"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction not found"
                    },
                    "data": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6a5df866bfa2c5a518b27859"
}
```