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

# Payment Methods

Retrieves a list of payment methods that are currently available.

# 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": {
    "/payment_methods?currency={currency}&side={side}": {
      "get": {
        "summary": "Payment Methods",
        "description": "Retrieves a list of payment methods that are currently available.",
        "operationId": "ramp",
        "parameters": [
          {
            "name": "currency",
            "in": "path",
            "description": "Eg: ngn",
            "schema": {
              "type": "string",
              "default": "ngn"
            },
            "required": true
          },
          {
            "name": "side",
            "in": "path",
            "description": "Can either be: on_ramp, off_ramp",
            "schema": {
              "type": "string",
              "default": "on_ramp"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"ok\",\n  \"message\": \"Payment methods fetched\",\n  \"data\": [\n    {\n      \"public_id\": \"d649b2ed-bddf-4c8e-8a44-1488434314e4\",\n      \"currency\": \"ngn\",\n      \"currency_name\": \"Nigerian Naira\",\n      \"title\": \"Bank Transfer\",\n      \"code\": \"bank_transfer\",\n      \"side\": \"ON_RAMP\",\n      \"active\": true,\n      \"created_at\": \"2025-04-15T13:23:40.520Z\",\n      \"updated_at\": \"2025-04-15T13:23:40.520Z\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Payment methods fetched"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "public_id": {
                            "type": "string",
                            "example": "d649b2ed-bddf-4c8e-8a44-1488434314e4"
                          },
                          "currency": {
                            "type": "string",
                            "example": "ngn"
                          },
                          "currency_name": {
                            "type": "string",
                            "example": "Nigerian Naira"
                          },
                          "title": {
                            "type": "string",
                            "example": "Bank Transfer"
                          },
                          "code": {
                            "type": "string",
                            "example": "bank_transfer"
                          },
                          "side": {
                            "type": "string",
                            "example": "ON_RAMP"
                          },
                          "active": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2025-04-15T13:23:40.520Z"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2025-04-15T13:23:40.520Z"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Invalid fiat currency": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Invalid fiat currency\",\n  \"data\": null\n}"
                  },
                  "Invalid side": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Invalid side\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Invalid fiat currency",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid fiat currency"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Invalid side",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Invalid side"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Invalid private key": {
                    "value": "{\n  \"status\": \"forbidden\",\n  \"message\": \"Invalid private key\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "forbidden"
                    },
                    "message": {
                      "type": "string",
                      "example": "Invalid private key"
                    },
                    "data": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6981ba5faf9470ee082aef50"
}
```