API Reference

Create a transaction (V2)

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

Reference
Playground

Create a V2 transaction for signing

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.

metadata

object

Key-value pairs for storing reference data. Up to 50 keys allowed, with key names up to 40 characters and values up to 500 characters.

Response

201TransactionResponseV2Wrapper

Response Body

object

data

object

Required

V2 transaction response schema containing details about the transaction amount, addresses, and status

Show 13 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

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.

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.

messageType

string

Required

Transaction message type for V2

Allowed valuesEIP3009SOLANAPAYMENT_SETTLEMENT_CONTRACT_V1_0_PAYMENT_INTENT

messageToBeSigned

object

Required

The message to be signed by OFI for V2 transactions.

metadata

object

Key-value pairs for storing reference data. Up to 50 keys allowed, with key names up to 40 characters and values up to 500 characters.

failureReason

string

Possible reasons for transaction failure

Allowed valuesCPN_PAYMENT_EXPIREDSIGNED_TRANSACTION_EXPIREDNONCE_TOO_LOWNONCE_TOO_HIGHINSUFFICIENT_TOKEN_BALANCEINSUFFICIENT_GAS_BALANCEGAS_PRICE_TOO_LOWOUT_OF_GASTX_REPLACEMENT_FAILEDSOL_TX_ALREADY_IN_CACHETX_ALREADY_CONFIRMEDFAILED_ONCHAINSOL_BLOCKHASH_EXPIREDTRANSACTION_EXPIREDBROADCAST_FAILEDRELAY_FAILEDUNKNOWN_REASON

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    "expireDate": "2023-01-01T12:04:05Z",
7    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
8    "blockchain": "ETH-SEPOLIA",
9    "amount": {
10      "amount": "110.270000",
11      "currency": "USDC"
12    },
13    "destinationAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
14    "messageType": "PAYMENT_SETTLEMENT_CONTRACT_V1_0_PAYMENT_INTENT",
15    "messageToBeSigned": {},
16    "metadata": {},
17    "failureReason": "FAILED_ONCHAIN",
18    "transactionHash": "2vmEDSBThR143WJyJePkpKVQcERVo9KePuCUwYU8fkoJaQjarTMj6sZG7DNnJ4zjhtRz6hDruqEFEkD4wJpGviiW"
19  }
20}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy