Create payment intent

Create a new payment intent between source and destination external accounts

The system will automatically find the optimal routing path and create compliance requirements based on the source and destination external accounts. Requires user authentication via uRamp JWT token.

Auto-Complete Feature: For returning customers who have already completed compliance requirements, the API will automatically create a transaction and return deposit instructions immediately, skipping the onboarding workflow. In this case, transaction will be present and frontendUrl will be null.

POST /intent

Create payment intent

cURL

curl --request POST \
  --url https://app.gnosisramp.com/api/v1/intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "srcExternalAccountId": "ext_acc_src_123",
  "destExternalAccountId": "ext_acc_dest_456",
  "amount": "100.50",
  "redirectUrl": "https://example.com/callback"
}
'

201

{
  "intent": {
    "id": "<string>",
    "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": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "currentRequirementCode": "<string>",
    "expiredAt": "2023-11-07T05:31:56Z",
    "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": "<string>",
  "workflowId": "<string>",
  "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

Body

application/json

Request to create a payment intent

srcExternalAccountId · string · required

Source external account identifier

Example:

"ext_acc_src_123"

destExternalAccountId · string · required

Destination external account identifier

Example:

"ext_acc_dest_456"

amount · string · required

Transfer amount as a decimal string (not a number to avoid precision issues)

Example:

"100.50"

redirectUrl · string<uri> | null

Optional redirect URL after intent completion

Example:

"https://example.com/callback"

Response

201

application/json

Intent created successfully

Intent creation response

intent · object · required

Show child attributes

frontendUrl · string<uri> | null · required

URL to view the intent in the hosted frontend (null if auto-completed)

workflowId · string | null · required

Temporal workflow identifier

transaction · object

Money movement transaction if auto-completed

Show child attributes