API Reference

Accelerate a stuck transaction

posthttps://api.circle.com/v1/cpn/payments/{paymentId}/transactions/accelerate

Reference
Playground

Accelerate a transaction based on the payment ID. It should be used when a transaction associated with the payment is broadcasted but not confirmed for a long period of time (i.e 10 minutes). This is usually due to gas fees being too low and not picked up by any miner/validator.
The /accelerate endpoint essentially creates another transaction with the same params as the broadcasted transaction. If multiple broadcasted transactions exist, it will use the newest created one. Afterwards, OFI can sign with a higher gas fee and submit via /submit endpoint to accelerate blockchain confirmation.
Requirements for using this endpoint:
- No COMPLETED transaction exist for the payment (otherwise onchain transaction has completed)
- No CREATED transaction exist for the payment, otherwise OFI should sign that transaction and submit
- No PENDING transaction exist for the payment, otherwise OFI should wait for transaction to be broadcasted
In another word, all existing transaction for the payment should either be FAILED (which is no longer effective) or BROADCASTED (which means they are stuck onchain and not confirmed)

Path parameters

paymentId

uuid

Required

The payment id created previously.

Body parameters

idempotencyKey

string

Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.

Response

201TransactionResponse

Response Body

object

data

object

Required

Response schema for a blockchain transaction containing details about the transaction amount, addresses, fees, and status

Show 15 properties

string

Required

System-generated unique identifier of the resource.

paymentId

string

Required

System-generated unique identifier of the resource.

status

string

Required

Lifecycle status of a transaction

Allowed valuesCREATEDPENDINGBROADCASTEDCOMPLETEDFAILED

failureReason

string

Possible reasons for transaction failure

Allowed valuesCPN_PAYMENT_EXPIREDSIGNED_TRANSACTION_EXPIREDNONCE_TOO_LOWINSUFFICIENT_TOKEN_BALANCEINSUFFICIENT_GAS_BALANCEGAS_PRICE_TOO_LOWOUT_OF_GASTX_REPLACEMENT_FAILEDSOL_TX_ALREADY_IN_CACHETX_ALREADY_CONFIRMEDFAILED_ON_ONCHAIN

expireDate

string

Required

Date and time when the resource expires

senderAddress

string

Required

A blockchain address that can be used to send or receive transactions on a blockchain network.

senderAccountType

string

Required

The type of blockchain account (currently supports only EOA - Externally Owned Account).

Allowed valuesEOA

blockchain

string

Required

Supported blockchain networks

Allowed valuesSOLMATICETHSOL-DEVNETMATIC-AMOYETH-SEPOLIA

amount

object

Required

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

destinationAddress

string

Required

A blockchain address that can be used to send or receive transactions on a blockchain network.

estimatedFee

object

The suggested fee is provided to guide the OFI in constructing and signing the transaction object for submission.

option 1: object

Show 2 properties

type

string

Allowed valuesEIP1559

payload

object

Payload containing EIP-1559 fee configuration parameters for Ethereum transactions

Show 3 properties

gasLimit

string

Maximum amount of gas units that can be used for the transaction

maxFeePerGas

string

Maximum total fee per gas (base fee + priority fee) in wei

maxPriorityFeePerGas

string

Maximum priority fee per gas (tip to miners) in wei

option 2: object

Show 2 properties

type

string

Required

Allowed valuesSOLANA

payload

object

Required

Payload containing Solana network fee configuration parameters

Show 2 properties

computeUnitLimit

string

Maximum number of compute units allowed for the transaction

computeUnitPrice

string

Price per compute unit in lamports (1 SOL = 1,000,000,000 lamports)

messageType

string

Required

Transaction message type

Allowed valuesEIP3009SOLANA

messageToBeSigned

object

Required

The message to be signed by OFI on Circle supported EVM chains and Solana (A EVM EOA message or a SOL message).

signedTransaction

string

Signed transaction. Base64 encoded for NEAR and Solana chains. Hex encoded for EVM chains.

transactionHash

string

Unique identifier assigned to a blockchain transaction when it is broadcast to the network

400BadRequestResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

401NotAuthorizedResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

403ForbiddenResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

404NotFoundResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5    "status": "PENDING",
6    "failureReason": "FAILED_ON_ONCHAIN",
7    "expireDate": "2023-01-01T12:04:05Z",
8    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
9    "senderAccountType": "EOA",
10    "blockchain": "ETH-SEPOLIA",
11    "amount": {
12      "amount": "110.27",
13      "currency": "USDC"
14    },
15    "destinationAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
16    "estimatedFee": {
17      "type": "EIP1559",
18      "payload": {
19        "gasLimit": "21000",
20        "maxFeePerGas": "5935224468",
21        "maxPriorityFeePerGas": "1022783914"
22      }
23    },
24    "messageType": "EIP3009",
25    "messageToBeSigned": {},
26    "signedTransaction": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABpzlAhqqen7eyTe0KQ3w+9NS4E+7sscb+Cr...",
27    "transactionHash": "2vmEDSBThR143WJyJePkpKVQcERVo9KePuCUwYU8fkoJaQjarTMj6sZG7DNnJ4zjhtRz6hDruqEFEkD4wJpGviiW"
28  }
29}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy