Skip to main content
GET
/
intent
/
requirements
Get intent requirements
curl --request GET \
  --url https://app.gnosisramp.com/api/v1/intent/requirements \
  --header 'Authorization: Bearer <token>'
{
  "src": {
    "currencyCode": "USD",
    "schema": {}
  },
  "dest": {
    "currencyCode": "USD",
    "schema": {}
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow for API authentication

Query Parameters

​
srcCurrencyCode
string
required

Source currency code (e.g., USD, BRL, USDC_ETH, USDC_POL)

Required string length: 2 - 20
Pattern: ^[A-Za-z0-9_]+$
​
destCurrencyCode
string
required

Destination currency code (e.g., USDC_ETH, USD, BRL)

Required string length: 2 - 20
Pattern: ^[A-Za-z0-9_]+$
​
rail
string

Optional payment rail filter (e.g., ACH, WIRE, PIX). When provided, returns a simplified schema for only this rail. Use this after obtaining a quote to get requirements specific to the selected rail.

​
providerId
string

Optional provider ID filter. When provided, returns a simplified schema for only this provider. Use this after obtaining a quote to get requirements specific to the selected provider.

Response

Requirements retrieved successfully

Requirements for creating source and destination accounts for a currency pair

​
src
object
required

Source account requirements

​
dest
object
required

Destination account requirements