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

# List Auto Swaps

Return all Auto Swaps created to your app, including each customer's details and static bank account. Use the filters and pagination to find specific accounts.

# 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/auto_swaps": {
      "get": {
        "summary": "List Auto Swaps",
        "description": "Return all Auto Swaps created to your app, including each customer's details and static bank account. Use the filters and pagination to find specific accounts.",
        "operationId": "list-auto-swaps",
        "parameters": [
          {
            "name": "per_page",
            "in": "query",
            "description": "Number of records per page. Must be a positive integer. Defaults to 25, max 50.",
            "schema": {
              "type": "string",
              "default": "25"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number. Must be a positive integer. Defaults to 1.",
            "schema": {
              "type": "string",
              "default": "1"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "ngn"
              ],
              "default": "ngn"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"ok\",\n  \"message\": \"Auto swaps fetched successfully\",\n  \"data\": [\n    {\n      \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"merchant_reference\": \"customer-1042-auto-swap\",\n      \"customer\": {\n        \"email\": \"customer@example.com\",\n        \"first_name\": \"Ada\",\n        \"last_name\": \"Okafor\"\n      },\n      \"side\": \"onramp\",\n      \"deposit_bank_account\": {\n        \"account_number\": \"0123456789\",\n        \"account_name\": \"Ada Okafor\",\n        \"currency\": \"ngn\",\n        \"bank_name\": \"Example Bank\",\n        \"bank_code\": \"000\"\n      }\n    }\n  ],\n  \"meta\": {\n    \"page\": 1,\n    \"per_page\": 25,\n    \"total_count\": 1,\n    \"total_pages\": 1,\n    \"next_page\": null\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Auto swaps fetched successfully"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "public_id": {
                            "type": "string",
                            "example": "550e8400-e29b-41d4-a716-446655440000"
                          },
                          "merchant_reference": {
                            "type": "string",
                            "example": "customer-1042-auto-swap"
                          },
                          "customer": {
                            "type": "object",
                            "properties": {
                              "email": {
                                "type": "string",
                                "example": "customer@example.com"
                              },
                              "first_name": {
                                "type": "string",
                                "example": "Ada"
                              },
                              "last_name": {
                                "type": "string",
                                "example": "Okafor"
                              }
                            }
                          },
                          "side": {
                            "type": "string",
                            "example": "onramp"
                          },
                          "deposit_bank_account": {
                            "type": "object",
                            "properties": {
                              "account_number": {
                                "type": "string",
                                "example": "0123456789"
                              },
                              "account_name": {
                                "type": "string",
                                "example": "Ada Okafor"
                              },
                              "currency": {
                                "type": "string",
                                "example": "ngn"
                              },
                              "bank_name": {
                                "type": "string",
                                "example": "Example Bank"
                              },
                              "bank_code": {
                                "type": "string",
                                "example": "000"
                              }
                            }
                          }
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "per_page": {
                          "type": "integer",
                          "example": 25,
                          "default": 0
                        },
                        "total_count": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "total_pages": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "next_page": {}
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "page must be a positive integer": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"page must be a positive integer\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "bad_request"
                    },
                    "message": {
                      "type": "string",
                      "example": "page must be a positive integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6ad52a3a488b520ab7506c78"
}
```