Create a transaction

curl --request POST \
  --url https://api.circle.com/v1/cpn/payments/{paymentId}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ETH-SEPOLIA",
  "senderAccountType": "EOA"
}
'

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "status": "PENDING",
    "expireDate": "2023-01-01T12:04:05Z",
    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "senderAccountType": "EOA",
    "blockchain": "ETH-SEPOLIA",
    "amount": {
      "amount": "110.270000",
      "currency": "USDC"
    },
    "destinationAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "messageType": "EIP3009",
    "messageToBeSigned": {},
    "failureReason": "FAILED_ONCHAIN",
    "estimatedFee": {
      "type": "EIP1559",
      "payload": {
        "gasLimit": "21000",
        "maxFeePerGas": "5935224468",
        "maxPriorityFeePerGas": "1022783914"
      }
    },
    "signedTransaction": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABpzlAhqqen7eyTe0KQ3w+9NS4E+7sscb+Cr...",
    "transactionHash": "2vmEDSBThR143WJyJePkpKVQcERVo9KePuCUwYU8fkoJaQjarTMj6sZG7DNnJ4zjhtRz6hDruqEFEkD4wJpGviiW"
  }
}

POST

cpn

payments

{paymentId}

transactions

Create a transaction

curl --request POST \
  --url https://api.circle.com/v1/cpn/payments/{paymentId}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ETH-SEPOLIA",
  "senderAccountType": "EOA"
}
'

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "status": "PENDING",
    "expireDate": "2023-01-01T12:04:05Z",
    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "senderAccountType": "EOA",
    "blockchain": "ETH-SEPOLIA",
    "amount": {
      "amount": "110.270000",
      "currency": "USDC"
    },
    "destinationAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "messageType": "EIP3009",
    "messageToBeSigned": {},
    "failureReason": "FAILED_ONCHAIN",
    "estimatedFee": {
      "type": "EIP1559",
      "payload": {
        "gasLimit": "21000",
        "maxFeePerGas": "5935224468",
        "maxPriorityFeePerGas": "1022783914"
      }
    },
    "signedTransaction": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABpzlAhqqen7eyTe0KQ3w+9NS4E+7sscb+Cr...",
    "transactionHash": "2vmEDSBThR143WJyJePkpKVQcERVo9KePuCUwYU8fkoJaQjarTMj6sZG7DNnJ4zjhtRz6hDruqEFEkD4wJpGviiW"
  }
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Path Parameters

paymentId

string<uuid>

required

The payment id created previously. System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Body

application/json

Create an on-chain transaction to fulfil the payment to BFI, the request will assemble an unsigned on chain transaction.

idempotencyKey

string<uuid>

required

Idempotency key to ensure transaction is only created once

Example:

"ETH-SEPOLIA"

senderAccountType

enum<string>

required

The OFI address. Should include the address and the network.

Available options:

EOA

Example:

"EOA"

Response

Transaction created successfully.

data

object

required

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

Show child attributes

data.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.paymentId

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.status

enum<string>

required

Lifecycle status of a transaction

Available options:

CREATED,

PENDING,

BROADCASTED,

COMPLETED,

FAILED

Example:

"PENDING"

data.expireDate

string<date-time>

required

Date and time when the resource expires

Example:

"2023-01-01T12:04:05Z"

data.senderAddress

string

required

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

Example:

"0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c"

data.senderAccountType

enum<string>

required

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

Available options:

EOA

Example:

"EOA"

data.blockchain

enum<string>

required

Supported blockchain networks

Available options:

SOL,

MATIC,

ETH,

SOL-DEVNET,

MATIC-AMOY,

ETH-SEPOLIA

Example:

"ETH-SEPOLIA"

data.amount

object

required

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

Show child attributes

data.amount.amount

string

Example:

"110.270000"

data.amount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.destinationAddress

string

required

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

Example:

"0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c"

data.messageType

enum<string>

required

Transaction message type

Available options:

EIP3009,

SOLANA

Example:

"EIP3009"

data.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).

data.failureReason

enum<string>

Possible reasons for transaction failure

Available options:

CPN_PAYMENT_EXPIRED,

SIGNED_TRANSACTION_EXPIRED,

NONCE_TOO_LOW,

NONCE_TOO_HIGH,

INSUFFICIENT_TOKEN_BALANCE,

INSUFFICIENT_GAS_BALANCE,

GAS_PRICE_TOO_LOW,

OUT_OF_GAS,

TX_REPLACEMENT_FAILED,

SOL_TX_ALREADY_IN_CACHE,

TX_ALREADY_CONFIRMED,

FAILED_ONCHAIN,

SOL_BLOCKHASH_EXPIRED,

TRANSACTION_EXPIRED,

BROADCAST_FAILED,

RELAY_FAILED,

UNKNOWN_REASON

Example:

"FAILED_ONCHAIN"

data.estimatedFee

object

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

Option 1
Option 2

Show child attributes

data.estimatedFee.type

enum<string>

Available options:

EIP1559

data.estimatedFee.payload

object

Payload containing EIP-1559 fee configuration parameters for Ethereum transactions

Show child attributes

data.estimatedFee.payload.gasLimit

string

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

Example:

"21000"

data.estimatedFee.payload.maxFeePerGas

string

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

Example:

"5935224468"

data.estimatedFee.payload.maxPriorityFeePerGas

string

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

Example:

"1022783914"

data.signedTransaction

string

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

Example:

"AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABpzlAhqqen7eyTe0KQ3w+9NS4E+7sscb+Cr..."

data.transactionHash

string

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

Example:

"2vmEDSBThR143WJyJePkpKVQcERVo9KePuCUwYU8fkoJaQjarTMj6sZG7DNnJ4zjhtRz6hDruqEFEkD4wJpGviiW"

Get refund details

Get a transaction

API Overview

Circle Payments Network

Create a transaction

Authorizations

Path Parameters

Body

Response