Skip to main content
POST
/
intent
Create payment intent
curl --request POST \
  --url https://app.gnosisramp.com/api/v1/intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "src": {
    "currencyCode": "USD",
    "details": {
      "countryCode": "US",
      "rail": "ACH",
      "provider": "BRIDGE"
    }
  },
  "dest": {
    "currencyCode": "USD",
    "details": {
      "countryCode": "US",
      "rail": "ACH",
      "provider": "BRIDGE"
    }
  },
  "srcAmount": "100.50",
  "onboardingRedirectUrl": "https://example.com/onboarding-complete",
  "checkoutRedirectUrl": "https://example.com/checkout-complete",
  "autoExecute": false,
  "providerId": "bridge"
}
'
{
  "intent": {
    "id": "<string>",
    "src": {
      "type": "BANK_ACCOUNT",
      "currency": {
        "ticker": "USDC",
        "name": "USD Coin",
        "code": "USDC_ETH",
        "type": "FIAT"
      },
      "details": {
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f42aB4"
      }
    },
    "dest": {
      "type": "BANK_ACCOUNT",
      "currency": {
        "ticker": "USDC",
        "name": "USD Coin",
        "code": "USDC_ETH",
        "type": "FIAT"
      },
      "details": {
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f42aB4"
      }
    },
    "status": "PENDING",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "srcAmount": "100.50",
    "currentRequirementCode": "<string>",
    "expiredAt": "2023-11-07T05:31:56Z",
    "type": "ONRAMP",
    "provider": "Bridge",
    "onboardingRedirectUrl": "<string>",
    "checkoutRedirectUrl": "<string>"
  },
  "onboardingUrl": "<string>",
  "transaction": {
    "id": "txn_123",
    "status": "PENDING",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "context": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ramp.gnosis.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

uRamp JWT bearer token for authenticated customer requests

Headers

​
Idempotency-Key
string

Optional unique key for exactly-once processing. When provided, the server guarantees that the request is processed at most once. Duplicate requests with the same key and body return the original cached response with the X-Idempotency-Replayed: true header. Using the same key with a different body returns 422. Keys are scoped per project and cached for 24 hours.

Maximum string length: 256

Body

application/json

Request to create a payment intent with inline account data

​
src
object
required

Source account details

​
dest
object
required

Destination account details

​
srcAmount
string
required

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

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"100.50"

​
onboardingRedirectUrl
string<uri> | null

Redirect URL after onboarding/compliance completion (must be http/https)

Example:

"https://example.com/onboarding-complete"

​
checkoutRedirectUrl
string<uri> | null

Redirect URL after checkout/payment completion (must be http/https)

Example:

"https://example.com/checkout-complete"

​
autoExecute
boolean
default:false

Auto-execute transaction after compliance completes

​
providerId
string | null

Preferred provider ID (must be a valid candidate for the payment path)

Example:

"bridge"

Response

Intent created successfully

Intent creation response

​
intent
object
required
​
onboardingUrl
string<uri> | null
required

URL for user to complete onboarding/compliance requirements (null if auto-completed)

​
transaction
object

Money movement transaction if auto-completed