Skip to main content
POST
/
v1
/
paymentIntents
Create a payment intent
curl --request POST \
  --url https://api-sandbox.circle.com/v1/paymentIntents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "amount": {
    "amount": "3.14",
    "currency": "USD"
  },
  "settlementCurrency": "USD",
  "paymentMethods": [
    {
      "type": "blockchain",
      "chain": "ALGO",
      "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
    }
  ],
  "merchantWalletId": "212000"
}
'
{
  "data": {
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "settlementCurrency": "USD",
    "paymentMethods": [
      {
        "type": "blockchain",
        "chain": "ALGO",
        "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
      }
    ],
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "amountPaid": {
      "amount": "3.14",
      "currency": "USD"
    },
    "amountRefunded": {
      "amount": "3.14",
      "currency": "USD"
    },
    "fees": [
      {
        "type": "blockchainLeaseFee",
        "amount": "3.14",
        "currency": "USD"
      }
    ],
    "paymentIds": [
      "69808f36-3e5e-4f37-bf82-ca79e4d70fc1"
    ],
    "refundIds": [
      "425dca6d-ac79-43b6-b0f9-43fdc51de91b"
    ],
    "timeline": [
      {
        "status": "created",
        "time": "2023-11-07T05:31:56Z",
        "context": "underpaid",
        "reason": "requested_by_merchant"
      }
    ],
    "expiresOn": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z",
    "createDate": "2020-04-10T02:13:30.000Z",
    "merchantWalletId": "212000"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

​
amount
object
required
​
settlementCurrency
enum<string>
required

Desired currency for the payments to settle in. This must match the currency used for the payment method.

Available options:
USD,
EUR,
BTC,
ETH
​
paymentMethods
object[]
required
​
merchantWalletId
string

Unique system generated identifier for the wallet of the merchant.

Maximum string length: 36
Example:

"212000"

Response

Successfully created a payment intent.

​
data
object