List intents

GET

/v2/onramp/intents

• Staging
• Development

List intents for a user/org. Compliance evidence, analytics, funnel metrics. Filter by customer and status with pagination.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Query Parameters

customerId

string

Customer identifier

Example

cus_1701234567890_abc123def

status

string

Allowed values: created awaiting_funds ready_to_execute completed failed canceled

Intent status filter

Example

awaiting_funds

page[number]

number

Page number (starts at 1)

Example

1

page[size]

number

Items per page

Example

10

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Responses

200

Intents plus pagination.

object

intents

required

Array<object>

object

intentId

required

string

quoteId

required

string

customerId

required

string

status

required

string

Allowed values: created awaiting_funds ready_to_execute completed failed canceled

intentLifecycle

required

object

createdAt

required

string

updatedAt

required

string

awaitingFundsAt

string

readyToExecuteAt

string

completedAt

string

canceledAt

string

failureReason

string

failureReason

string

quoteDetails

required

object

quoteId

required

Unique quote identifier

string

status

required

Current quote status

string

Allowed values: firm_locked indicative used expired canceled

request

required

object

source

required

object

currency

required

Source currency (e.g., PHP)

string

amount

required

Amount (decimal string)

string

paymentRail

required

string

Allowed values: instapay pesonet wire rtgs

destination

required

object

chain

required

string

Allowed values: base ethereum polygon

currencyName

required

Currency name (e.g., PHPX)

string

walletId

required

Wallet ID (UUID)

string

quoteConstraints

required

object

minReceiveAmount

Minimum destination amount user will receive (decimal string)

string

maxSlippageBps

Maximum allowed slippage (decimal string)

string

ttlSeconds

Quote validity duration in seconds

number

jurisdictionCode

Regulatory jurisdiction

string

riskContext

object

ip

string

deviceId

string

geo

string

source

required

object

currency

required

Source currency (e.g., PHP)

string

amount

required

Amount (decimal string)

string

paymentRail

required

string

Allowed values: instapay pesonet wire rtgs

destination

required

object

chain

required

string

Allowed values: base ethereum polygon

currencyName

required

Currency name (e.g., PHPX)

string

walletId

required

Wallet ID (UUID)

string

quoteConstraints

required

object

minReceiveAmount

Minimum destination amount user will receive (decimal string)

string

maxSlippageBps

Maximum allowed slippage (decimal string)

string

ttlSeconds

Quote validity duration in seconds

number

jurisdictionCode

Regulatory jurisdiction

string

pricing

required

object

exchangeRate

required

Effective rate PHP → PHPX (after fees/slippage)

string

midRate

Optional mid/indicative rate (pre-fee)

string

fxSpreadBps

Optional spread vs mid

number

amounts

required

Input/output amounts

object

fees

required

object

totalFee

required

Total fees in source currency (decimal string)

string

fiatFundingFee

required

Bank/payment-rail fees (source currency)

string

exchangeFee

required

FX markup/fee (source currency)

string

networkFee

required

On-chain/network fees (source currency)

string

platformFee

required

Platform/service fees (source currency)

string

networkFeeQuote

Raw network fee quoted

object

pricedAt

required

Timestamp when pricing was calculated

string

pricingModelId

Pricing model/version identifier

string

fundingInstructions

required

object

rail

required

string

Allowed values: instapay pesonet wire rtgs

bankCountry

required

Country/region of the funding bank

string

accountName

required

string

accountNumber

required

string

bankCode

BIC/SWIFT or local code

string

reference

required

Reference for auto-reconciliation

string

lifecycle

required

object

createdAt

required

string

expiresAt

required

string

usedAt

string

updatedAt

required

string

page

required

object

number

required

Page number (starts at 1)

number

1

size

required

Items per page

number

10

totalPages

required

Total number of items

number

100

totalCount

required

Total number of pages

number

10

hasNext

required

Whether there is a next page

boolean

true

hasPrev

required

Whether there is a previous page

boolean

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error