Skip to main content
GET
/
intent
Get all payment intents
curl --request GET \
  --url https://app.gnosisramp.com/api/v1/intent \
  --header 'Authorization: Bearer <token>'
[
  {
    "intent": {
      "id": "intent_123",
      "src": {
        "id": "ext_acc_12345",
        "type": "BANK_ACCOUNT",
        "currencyId": "usd-currency-id",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "metadata": {},
        "label": "Personal Checking Account",
        "customerId": "customer-123",
        "currency": {
          "id": "usd-currency-id",
          "ticker": "USDC",
          "name": "USD Coin",
          "code": "USDC_ETH",
          "decimals": 6,
          "type": "FIAT",
          "createdAt": "2024-01-01T00:00:00.000Z",
          "updatedAt": "2024-01-01T00:00:00.000Z"
        }
      },
      "dest": {
        "id": "ext_acc_12345",
        "type": "BANK_ACCOUNT",
        "currencyId": "usd-currency-id",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "metadata": {},
        "label": "Personal Checking Account",
        "customerId": "customer-123",
        "currency": {
          "id": "usd-currency-id",
          "ticker": "USDC",
          "name": "USD Coin",
          "code": "USDC_ETH",
          "decimals": 6,
          "type": "FIAT",
          "createdAt": "2024-01-01T00:00:00.000Z",
          "updatedAt": "2024-01-01T00:00:00.000Z"
        }
      },
      "status": "PENDING",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "currentRequirementCode": "KYC_VERIFICATION",
      "expiredAt": "2024-12-31T23:59:59.000Z",
      "transferAmount": {
        "amount": "100.50",
        "currencyCode": "USD"
      },
      "mmPlan": {
        "id": "mm_plan_123",
        "type": "ONRAMP",
        "providerAccountId": "provider_acc_123",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "providerAccount": {
          "id": "<string>",
          "providerCode": "NOAH",
          "providerName": "Noah"
        }
      },
      "compliancePlan": {
        "id": "compliance_plan_123",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "currentStepCode": "KYC_VERIFICATION",
        "steps": [
          {
            "id": "step_123",
            "code": "KYC_VERIFICATION",
            "description": "Complete KYC verification",
            "createdAt": "2024-01-01T00:00:00.000Z",
            "updatedAt": "2024-01-01T00:00:00.000Z",
            "metadata": {},
            "complianceEdge": {
              "id": "<string>"
            }
          }
        ]
      },
      "redirectUrl": "<string>"
    },
    "frontendUrl": "https://dashboard.uramp.io/intent/intent_123",
    "workflowId": "workflow_123",
    "transaction": {
      "id": "txn_123",
      "intentId": "intent_123",
      "status": "PENDING",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "lastActivityAt": "2024-01-01T00:00:00.000Z",
      "context": {}
    }
  }
]

Authorizations

Authorization
string
header
required

uRamp JWT bearer token for authenticated customer requests

Response

List of intents retrieved successfully

intent
object
required
frontendUrl
string<uri> | null

URL to view the intent in the hosted frontend

Example:

"https://dashboard.uramp.io/intent/intent_123"

workflowId
string | null

Temporal workflow identifier

Example:

"workflow_123"

transaction
object

Money movement transaction if available