Cancel Payment Intent
POST /v2/send/payment-intents/{paymentIntentId}/cancel
POST
/v2/send/payment-intents/{paymentIntentId}/cancel
Cancel a pending payment intent
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” paymentIntentId
required
string format: uuid
Payment Intent ID
Example
e271bc5c-f870-44cd-8462-54280d0411f6 SendPaymentIntentIdParamDto
required
Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Request Body required
Section titled “Request Body required ”object
userId
required
External user ID from the BFF
string format: uuid
e271bc5c-f870-44cd-8462-54280d0411f6Responses
Section titled “ Responses ”The resource has been successfully updated.
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
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
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error