Create a payment intent
posthttps://api-sandbox.circle.com/v1/paymentIntents
- Reference
- Playground
Create a transient or continuous payment intent
Body parameters
option 1: object
idempotencyKey
string
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
amount
object
Required
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
Allowed valuesUSDEURETHBTC
settlementCurrency
string
Required
Desired currency for the payments to settle in. This must match the currency used for the payment method.
Allowed valuesUSDEURBTCETH
paymentMethods
array of objects
Required
type
string
Required
Allowed valuesblockchain
chain
string
Required
The blockchain network for the payment.
Allowed valuesALGOARBAVAXBASEBTCETHHBARNOBLEOPPOLYSOLSUIXLM
address
string
merchantWalletId
string
Unique system generated identifier for the wallet of the merchant.
option 2: object
idempotencyKey
string
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
currency
string
Required
Desired currency for the payment
Allowed valuesUSDEURBTCETH
settlementCurrency
string
Required
Desired currency for the payments to settle in. This must match the currency used for the payment.
Allowed valuesUSDEURBTCETH
paymentMethods
array of objects
Required
type
string
Required
Allowed valuesblockchain
chain
string
Required
The blockchain network for the payment.
Allowed valuesALGOARBAVAXBASEBTCETHHBARNOBLEOPPOLYSOLSUIXLM
address
string
merchantWalletId
string
Unique system generated identifier for the wallet of the merchant.
type
string
Allowed valuescontinuous
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "amount": {
5 "amount": "3.14",
6 "currency": "USD"
7 },
8 "amountPaid": {
9 "amount": "3.14",
10 "currency": "USD"
11 },
12 "amountRefunded": {
13 "amount": "3.14",
14 "currency": "USD"
15 },
16 "settlementCurrency": "USD",
17 "paymentMethods": [
18 {
19 "type": "blockchain",
20 "chain": "ALGO",
21 "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
22 }
23 ],
24 "fees": [
25 {
26 "type": "blockchainLeaseFee",
27 "amount": "3.14",
28 "currency": "USD"
29 }
30 ],
31 "paymentIds": [
32 "69808f36-3e5e-4f37-bf82-ca79e4d70fc1"
33 ],
34 "refundIds": [
35 "425dca6d-ac79-43b6-b0f9-43fdc51de91b"
36 ],
37 "timeline": [
38 {
39 "status": "created",
40 "context": "underpaid",
41 "reason": "requested_by_merchant",
42 "time": ""
43 }
44 ],
45 "expiresOn": "2020-04-10T02:13:30.000Z",
46 "updateDate": "2020-04-10T02:13:30.000Z",
47 "createDate": "2020-04-10T02:13:30.000Z",
48 "merchantWalletId": "212000"
49 }
50}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
