Get payments
Retrieve all payments for the authenticated user's organization. Returns payment details including steps, amounts, and statuses.
query Parameters
startDatestringStart date for filtering payments (ISO 8601 format)
endDatestringEnd date for filtering payments (ISO 8601 format)
statusstring · enumPayment status for filtering payments
Enum values:queuedprocessingready-to-submitrejectedsentneed-reviewcompliance-blockedinsufficient-balancepaymentTypestring · enumPayment type filter: 'stablecoin' for stablecoin payments, 'fiat' for fiat payments
Enum values:stablecoinfiatpagenumberPage number for pagination (1-based)
limitnumberNumber of items per page (default: 25)
Responses
Successfully retrieved team payments
dataobject[] · requiredList of payments
paginationobjectPagination information
Get payment by ID
Retrieve a specific payment by ID for the authenticated user's team. Returns payment details including current status.
path Parameters
paymentIdstring · uuid · requiredUnique identifier of the payment to retrieve
Example: 123e4567-e89b-12d3-a456-426614174000
Responses
Successfully retrieved payment
dataobject
Create payment intent
Create a new payment intent for processing. The payment will not be sent to the blockchain until you explicitly execute this payment. This endpoint:
- Validates the team has active webhooks
- Creates a payment record with steps
- Sends a payment creation message
- Returns payment details and webhook availability status
Request Body
idempotencyKeystring · uuid · pattern:^([0-9a-fA-F]{8}-[0-…· requiredoriginatorIdstring · uuid · pattern:^([0-9a-fA-F]{8}-[0-…· requiredfromAccountstring · requiredtoAccountstring · requiredtoAmountstring · pattern:^\d+$· requiredfromCurrencystring · requiredtoCurrencystring · required
paymentTypestring · enumEnum values:onchainofframpDefault: onchainexternalIdstring
Responses
Payment intent created successfully
dataobject · requiredPayment details
Execute payment
Execute a previously created payment intent by submitting the signed transaction. This endpoint:
- Validates the signed transaction matches the payment intent
- Submits the transaction to the blockchain
- Updates payment status and records transaction hash
- Monitors transaction confirmation (in development mode)
Request Body
signedTransactionstring · requiredpaymentIdstring · requiredexternalIdstring · requiredfromWalletAddressstring · requiredtoAccountstring · requiredtoAmountstring · pattern:^\d+$· requiredcurrencystring · required
Responses
Payment transaction submitted successfully
datastring · required
Submit compliance review
Manually review and approve or reject a payment requiring compliance review. This endpoint:
- Updates payment approval status
- Records review timestamp and reviewer information
- Returns updated payment compliance data
- Requires appropriate compliance permissions
path Parameters
paymentIdstring · uuid · requiredUnique identifier of the payment to review
Example: 123e4567-e89b-12d3-a456-426614174000
Responses
Payment review completed successfully
messagestring · requiredSuccess message
dataobject · requiredReview details
Get compliance screening
Retrieve compliance screening results for a specific payment. Returns:
- Risk score and risk indicators count
- Raw screening response data
- Compliance action recommendations
- Transaction analysis details
path Parameters
paymentIdstring · uuid · requiredUnique identifier of the payment to get screening results for
Example: 123e4567-e89b-12d3-a456-426614174000
Responses
Compliance screening result retrieved successfully
messagestringExample: Screening result retrieved successfullydataobject