Skip to content
FSCO Docs

List Payment Intents

GET
/v2/send/payment-intents

List payment intents with pagination and optional status filtering

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
number
required
number

Page number (starts at 1)

Example
1
size
required
number

Items per page

Example
10
totalPages
required
number

Total number of items

Example
100
totalCount
required
number

Total number of pages

Example
10
hasNext
required
boolean

Whether there is a next page

Example
true
hasPrev
required
boolean

Whether there is a previous page

status
string
Allowed values: pending networkinprogress networkfailed networkcompleted payoutinprogress payoutfailed payoutcompleted completed failed refunded

Filter by payment intent status

Example
pending
userId
string format: uuid

Filter by external user ID

Example
e271bc5c-f870-44cd-8462-54280d0411f6
page[number]
number

Page number (starts at 1)

Example
1
page[size]
number

Items per page

Example
10

Header Parameters

Section titled “Header Parameters ”
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated list of payment intents

object
items
required

List of payment intents

Array<object>
object
id
required

Payment Intent ID

string format: uuid 
e271bc5c-f870-44cd-8462-54280d0411f6
quoteId
required

Quote ID

string format: uuid 
e271bc5c-f870-44cd-8462-54280d0411f6
organisationId
required

Organisation ID

string format: uuid 
e271bc5c-f870-44cd-8462-54280d0411f6
userId
required

User ID

string format: uuid 
e271bc5c-f870-44cd-8462-54280d0411f6
pin
required

The pin for the payment intent

string
status
required

Payment Intent Status

string
Allowed values: pending networkinprogress networkfailed networkcompleted payoutinprogress payoutfailed payoutcompleted completed failed refunded 
pending
walletAddress
required

Wallet address

string
recipientId
required

Recipient ID

string format: uuid
typedData

Typed data

string
transactionHash

Transaction hash

string
0x1234567890abcdef...
completedAt

Execution timestamp

string format: date-time 
2023-12-01T10:00:00Z
createdAt

Creation timestamp

string format: date-time 
2023-12-01T10:00:00Z
txData

Transaction data for depositWithAuthAndPermit with placeholder permit signature

object
permitParams

Permit parameters for frontend to sign

object
page
required

Pagination info

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

Section titled “400 ”

Bad Request

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden

404

Section titled “404 ”

Not Found

500

Section titled “500 ”

Internal Server Error