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",
  "paymentMethods": [
    {
      "type": "blockchain"
    }
  ],
  "merchantWalletId": "212000",
  "purposeOfTransfer": "PMT001",
  "type": "continuous",
  "metadata": {
    "customerExternalRef": "INV-2024-001234"
  }
}
'

import requests

url = "https://api-sandbox.circle.com/v1/paymentIntents"

payload = {
    "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
    "paymentMethods": [{ "type": "blockchain" }],
    "merchantWalletId": "212000",
    "purposeOfTransfer": "PMT001",
    "type": "continuous",
    "metadata": { "customerExternalRef": "INV-2024-001234" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    paymentMethods: [{type: 'blockchain'}],
    merchantWalletId: '212000',
    purposeOfTransfer: 'PMT001',
    type: 'continuous',
    metadata: {customerExternalRef: 'INV-2024-001234'}
  })
};

fetch('https://api-sandbox.circle.com/v1/paymentIntents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/paymentIntents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    'paymentMethods' => [
        [
                'type' => 'blockchain'
        ]
    ],
    'merchantWalletId' => '212000',
    'purposeOfTransfer' => 'PMT001',
    'type' => 'continuous',
    'metadata' => [
        'customerExternalRef' => 'INV-2024-001234'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/paymentIntents"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/paymentIntents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/paymentIntents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "8755d0ea-14f9-4259-b092-de23c14b6568",
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "amountPaid": {
      "amount": "0.00",
      "currency": "USD"
    },
    "settlementCurrency": "USD",
    "paymentMethods": [
      {
        "type": "blockchain",
        "chain": "ETH",
        "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
      }
    ],
    "paymentIds": [],
    "customerExternalRef": "customer-ref-123",
    "timeline": [
      {
        "status": "created",
        "time": "2022-07-21T20:13:35.579331Z"
      }
    ],
    "purposeOfTransfer": "PMT001",
    "expiresOn": "2022-08-04T20:13:35.578678Z",
    "createDate": "2022-07-21T20:13:35.578678Z",
    "updateDate": "2022-07-21T20:19:24.859052Z"
  }
}

Create a payment intent

Create a continuous (default) or transient payment intent. Continuous payment intents are created by default. To create a transient payment intent, the type field must be explicitly set to transient.

purposeOfTransfer is conditionally required: it must be supplied when the entity’s legal entity is Circle SG (CIRCLE_SG), or Circle Inc (CIRCLE_INC) with Managed Payments enabled; it is optional for other legal entities. PMT006 is not allowed.

POST

paymentIntents

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",
  "paymentMethods": [
    {
      "type": "blockchain"
    }
  ],
  "merchantWalletId": "212000",
  "purposeOfTransfer": "PMT001",
  "type": "continuous",
  "metadata": {
    "customerExternalRef": "INV-2024-001234"
  }
}
'

import requests

url = "https://api-sandbox.circle.com/v1/paymentIntents"

payload = {
    "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
    "paymentMethods": [{ "type": "blockchain" }],
    "merchantWalletId": "212000",
    "purposeOfTransfer": "PMT001",
    "type": "continuous",
    "metadata": { "customerExternalRef": "INV-2024-001234" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    paymentMethods: [{type: 'blockchain'}],
    merchantWalletId: '212000',
    purposeOfTransfer: 'PMT001',
    type: 'continuous',
    metadata: {customerExternalRef: 'INV-2024-001234'}
  })
};

fetch('https://api-sandbox.circle.com/v1/paymentIntents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/paymentIntents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => 'ba943ff1-ca16-49b2-ba55-1057e70ca5c7',
    'paymentMethods' => [
        [
                'type' => 'blockchain'
        ]
    ],
    'merchantWalletId' => '212000',
    'purposeOfTransfer' => 'PMT001',
    'type' => 'continuous',
    'metadata' => [
        'customerExternalRef' => 'INV-2024-001234'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/paymentIntents"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/paymentIntents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/paymentIntents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"ba943ff1-ca16-49b2-ba55-1057e70ca5c7\",\n  \"paymentMethods\": [\n    {\n      \"type\": \"blockchain\"\n    }\n  ],\n  \"merchantWalletId\": \"212000\",\n  \"purposeOfTransfer\": \"PMT001\",\n  \"type\": \"continuous\",\n  \"metadata\": {\n    \"customerExternalRef\": \"INV-2024-001234\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "8755d0ea-14f9-4259-b092-de23c14b6568",
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "amountPaid": {
      "amount": "0.00",
      "currency": "USD"
    },
    "settlementCurrency": "USD",
    "paymentMethods": [
      {
        "type": "blockchain",
        "chain": "ETH",
        "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
      }
    ],
    "paymentIds": [],
    "customerExternalRef": "customer-ref-123",
    "timeline": [
      {
        "status": "created",
        "time": "2022-07-21T20:13:35.579331Z"
      }
    ],
    "purposeOfTransfer": "PMT001",
    "expiresOn": "2022-08-04T20:13:35.578678Z",
    "createDate": "2022-07-21T20:13:35.578678Z",
    "updateDate": "2022-07-21T20:19:24.859052Z"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Option 1
Option 2

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"

currency

enum<string>

required

Desired currency for the payment

Available options:

USD,

EUR

settlementCurrency

enum<string>

required

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

Available options:

USD,

EUR

paymentMethods

object[]

required

Show child attributes

merchantWalletId

string

required

Unique system generated identifier for the wallet of the merchant.

Maximum string length: 36

Example:

"212000"

purposeOfTransfer

enum<string>

Payment reason code describing the purpose of the transfer for the payment intent.

Conditionally required: it must be supplied when the entity's legal entity is Circle SG (CIRCLE_SG), or Circle Inc (CIRCLE_INC) with Managed Payments enabled. It is optional for all other legal entities.

PMT006 (Transfer to own account) is not allowed for payment intents. A missing value (when required) or a disallowed/invalid value returns error code INVALID_PURPOSE_OF_TRANSFER.

Available options:

PMT000,

PMT001,

PMT002,

PMT003,

PMT004,

PMT005,

PMT007,

PMT008,

PMT009,

PMT010,

PMT011,

PMT012,

PMT013,

PMT014,

PMT015,

PMT016,

PMT017,

PMT018,

PMT019,

PMT020,

PMT021,

PMT022,

PMT023,

PMT024,

PMT025,

PMT026,

PMT027,

PMT028,

PMT029,

PMT030

Example:

"PMT001"

type

enum<string>

default:continuous

Payment intent type. Defaults to 'continuous' if not specified.

Available options:

continuous

metadata

object

Optional metadata associated with the payment intent.

Show child attributes

Response

Successfully created a payment intent.

data

object

Option 1
Option 2

Show child attributes

List all payment intents

Get a payment intent

⌘I

API overview

Fiat payouts

Managed Payments

Stablecoin payments

Create a payment intent

Authorizations

Body

Response