Get a payment intent

curl --request GET \
  --url https://api-sandbox.circle.com/v1/paymentIntents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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"
  }
}

GET

paymentIntents

{id}

Get a payment intent

curl --request GET \
  --url https://api-sandbox.circle.com/v1/paymentIntents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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.

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved a payment intent.

data

object

Option 1
Option 2

Show child attributes

data.amount

object

required

Show child attributes

data.amount.amount

string

required

Magnitude of the amount, in units of the currency, with a ..

Example:

"3.14"

data.amount.currency

enum<string>

required

Currency code.

Available options:

USD,

EUR,

ETH,

BTC

data.settlementCurrency

enum<string>

required

Desired currency for the payments to settle in.

Available options:

USD,

BTC,

ETH

data.paymentMethods

object[]

required

Show child attributes

data.paymentMethods.type

enum<string>

required

Available options:

blockchain

data.paymentMethods.chain

enum<string>

required

The blockchain network for the payment.

Available options:

ALGO,

ARB,

AVAX,

BASE,

BTC,

ETH,

HBAR,

NOBLE,

OP,

POLY,

SOL,

SUI,

XLM

data.paymentMethods.address

string

Example:

"0x8381470ED67C3802402dbbFa0058E8871F017A6F"

data.id

string<uuid>

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.amountPaid

object

Show child attributes

data.amountPaid.amount

string

required

Magnitude of the amount, in units of the currency, with a ..

Example:

"3.14"

data.amountPaid.currency

enum<string>

required

Currency code.

Available options:

USD,

EUR,

ETH,

BTC

data.amountRefunded

object

Show child attributes

data.amountRefunded.amount

string

required

Magnitude of the amount, in units of the currency, with a ..

Example:

"3.14"

data.amountRefunded.currency

enum<string>

required

Currency code.

Available options:

USD,

EUR,

ETH,

BTC

data.fees

object[]

Show child attributes

data.fees.type

enum<string>

required

Available options:

blockchainLeaseFee,

totalPaymentFees

data.fees.amount

string

required

Magnitude of the amount, in units of the currency, with a ..

Example:

"3.14"

data.fees.currency

enum<string>

required

Currency code.

Available options:

USD,

BTC,

ETH

data.paymentIds

string<uuid>[]

List of associated payments.

data.refundIds

string<uuid>[]

List of associated refunds.

data.timeline

object[]

State management timeline.

Show child attributes

data.timeline.status

enum<string>

required

Available options:

created,

pending,

complete,

expired,

failed,

refunded

data.timeline.time

string<date-time>

required

ISO-8601 UTC date/time format.

data.timeline.context

enum<string>

Available options:

underpaid,

paid,

overpaid

data.timeline.reason

enum<string>

Available options:

requested_by_merchant,

fee_collection_failed

data.expiresOn

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.updateDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.createDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.merchantWalletId

string

Unique system generated identifier for the wallet of the merchant.

Maximum string length: 36

Example:

"212000"

Create a payment intent

Expire a payment intent

Core API

API Overview

Core API for Institutions

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Get a payment intent

Authorizations

Path Parameters

Response