---
updatedAt: 2026-07-28T09:00:00.000Z
agentTools:
  projectIndex: https://docs.onramper.com/llms.txt
---

# Get Onramp Metadata

Retruns metadata for all supported onramps available for a specified transaction type.

🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Onramper API Collection V2",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.onramper.com"
    },
    {
      "url": "https://api-stg.onramper.com"
    }
  ],
  "tags": [
    {
      "name": "Supported"
    }
  ],
  "paths": {
    "/supported/onramps/all": {
      "get": {
        "tags": [
          "Supported"
        ],
        "summary": "Get Onramp Metadata",
        "description": "Retruns metadata for all supported onramps available for a specified transaction type.\n\n🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "pk_prod_01HETEQF46GSK6BS5JWKDF31BT"
          },
          {
            "name": "type",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Transaction type (buy/sell). Default: buy",
            "example": "buy"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Transfer-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "chunked"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Thu, 21 Sep 2023 06:27:44 GMT"
                }
              },
              "Apigw-Requestid": {
                "schema": {
                  "type": "string",
                  "example": "LmBPEhjlIAMEV5g="
                }
              },
              "Content-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "gzip"
                }
              },
              "Vary": {
                "schema": {
                  "type": "string",
                  "example": "Accept-Encoding"
                }
              },
              "X-Cache": {
                "schema": {
                  "type": "string",
                  "example": "Miss from cloudfront"
                }
              },
              "Via": {
                "schema": {
                  "type": "string",
                  "example": "1.1 f7712655aa6587fbf06c55b40ebb2680.cloudfront.net (CloudFront)"
                }
              },
              "X-Amz-Cf-Pop": {
                "schema": {
                  "type": "string",
                  "example": "IAD12-P4"
                }
              },
              "X-Amz-Cf-Id": {
                "schema": {
                  "type": "string",
                  "example": "cnvTzA9YXsIcnCJA1oYrE5rvY44JSi9_l6oIEZGJzlSUD4xhuNlT5Q=="
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "message": [
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/utorg-colored.svg",
                      "displayName": "UTORG",
                      "id": "utorg",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/utorg-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/utorg-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/utorg-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/sardine-colored.svg",
                      "displayName": "Sardine",
                      "id": "sardine",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/sardine-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/sardine-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/sardine-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/stripe-colored.svg",
                      "displayName": "Stripe",
                      "id": "stripe",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/stripe-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/stripe-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/stripe-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/coinify-colored.svg",
                      "displayName": "Coinify",
                      "id": "coinify",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/coinify-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/coinify-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/coinify-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/onrampmoney-colored.svg",
                      "displayName": "Onramp Money",
                      "id": "onrampmoney",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/onrampmoney-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/onrampmoney-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/onrampmoney-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/localramp-colored.svg",
                      "displayName": "LocalRamp",
                      "id": "localramp",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/localramp-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/localramp-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/localramp-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/alchemypay-colored.svg",
                      "displayName": "Alchemy Pay",
                      "id": "alchemypay",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/alchemypay-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/alchemypay-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/alchemypay-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/transfi-colored.svg",
                      "displayName": "TransFi",
                      "id": "transfi",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/transfi-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/transfi-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/transfi-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/gatefi-colored.svg",
                      "displayName": "Unlimit",
                      "id": "gatefi",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/gatefi-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/gatefi-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/gatefi-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/guardarian-colored.svg",
                      "displayName": "Guardarian",
                      "id": "guardarian",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/guardarian-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/guardarian-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/guardarian-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/onmeta-colored.svg",
                      "displayName": "Onmeta",
                      "id": "onmeta",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/onmeta-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/onmeta-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/onmeta-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/topper-colored.svg",
                      "displayName": "Topper",
                      "id": "topper",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/topper-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/topper-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/topper-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/fonbnk-colored.svg",
                      "displayName": "Fonbnk",
                      "id": "fonbnk",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/fonbnk-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/fonbnk-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/fonbnk-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/banxa-colored.svg",
                      "displayName": "Banxa",
                      "id": "banxa",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/banxa-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/banxa-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/banxa-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/neocrypto-colored.svg",
                      "displayName": "Neocrypto",
                      "id": "neocrypto",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/neocrypto-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/neocrypto-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/neocrypto-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/koywe-colored.svg",
                      "displayName": "Koywe",
                      "id": "koywe",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/koywe-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/koywe-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/koywe-colored-160.png"
                        }
                      }
                    },
                    {
                      "icon": "https://cdn.onramper.com/icons/onramps/gateconnect-colored.svg",
                      "displayName": "GateConnect",
                      "id": "gateconnect",
                      "icons": {
                        "svg": "https://cdn.onramper.com/icons/onramps/gateconnect-colored.svg",
                        "png": {
                          "32x32": "https://cdn.onramper.com/icons/onramps/gateconnect-colored.png",
                          "160x160": "https://cdn.onramper.com/icons/onramps/gateconnect-colored-160.png"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Transfer-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "chunked"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Thu, 21 Sep 2023 06:27:44 GMT"
                }
              },
              "Apigw-Requestid": {
                "schema": {
                  "type": "string",
                  "example": "LmBPEhjlIAMEV5g="
                }
              },
              "Content-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "gzip"
                }
              },
              "Vary": {
                "schema": {
                  "type": "string",
                  "example": "Accept-Encoding"
                }
              },
              "X-Cache": {
                "schema": {
                  "type": "string",
                  "example": "Miss from cloudfront"
                }
              },
              "Via": {
                "schema": {
                  "type": "string",
                  "example": "1.1 f7712655aa6587fbf06c55b40ebb2680.cloudfront.net (CloudFront)"
                }
              },
              "X-Amz-Cf-Pop": {
                "schema": {
                  "type": "string",
                  "example": "IAD12-P4"
                }
              },
              "X-Amz-Cf-Id": {
                "schema": {
                  "type": "string",
                  "example": "cnvTzA9YXsIcnCJA1oYrE5rvY44JSi9_l6oIEZGJzlSUD4xhuNlT5Q=="
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "message": "Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Transfer-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "chunked"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Thu, 21 Sep 2023 06:27:44 GMT"
                }
              },
              "Apigw-Requestid": {
                "schema": {
                  "type": "string",
                  "example": "LmBPEhjlIAMEV5g="
                }
              },
              "Content-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "gzip"
                }
              },
              "Vary": {
                "schema": {
                  "type": "string",
                  "example": "Accept-Encoding"
                }
              },
              "X-Cache": {
                "schema": {
                  "type": "string",
                  "example": "Miss from cloudfront"
                }
              },
              "Via": {
                "schema": {
                  "type": "string",
                  "example": "1.1 f7712655aa6587fbf06c55b40ebb2680.cloudfront.net (CloudFront)"
                }
              },
              "X-Amz-Cf-Pop": {
                "schema": {
                  "type": "string",
                  "example": "IAD12-P4"
                }
              },
              "X-Amz-Cf-Id": {
                "schema": {
                  "type": "string",
                  "example": "cnvTzA9YXsIcnCJA1oYrE5rvY44JSi9_l6oIEZGJzlSUD4xhuNlT5Q=="
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "message": "Forbidden"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Transfer-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "chunked"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Thu, 21 Sep 2023 06:27:44 GMT"
                }
              },
              "Apigw-Requestid": {
                "schema": {
                  "type": "string",
                  "example": "LmBPEhjlIAMEV5g="
                }
              },
              "Content-Encoding": {
                "schema": {
                  "type": "string",
                  "example": "gzip"
                }
              },
              "Vary": {
                "schema": {
                  "type": "string",
                  "example": "Accept-Encoding"
                }
              },
              "X-Cache": {
                "schema": {
                  "type": "string",
                  "example": "Miss from cloudfront"
                }
              },
              "Via": {
                "schema": {
                  "type": "string",
                  "example": "1.1 f7712655aa6587fbf06c55b40ebb2680.cloudfront.net (CloudFront)"
                }
              },
              "X-Amz-Cf-Pop": {
                "schema": {
                  "type": "string",
                  "example": "IAD12-P4"
                }
              },
              "X-Amz-Cf-Id": {
                "schema": {
                  "type": "string",
                  "example": "cnvTzA9YXsIcnCJA1oYrE5rvY44JSi9_l6oIEZGJzlSUD4xhuNlT5Q=="
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "message": "Internal server error occurred. Please try again later."
                }
              }
            }
          }
        }
      }
    }
  }
}
```