List all crypto payments

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/payments', 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/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "payment",
      "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
      "amount": {
        "currency": "USD",
        "amount": "3.14"
      },
      "status": "pending",
      "merchantWalletId": "1000662322",
      "statusReason": "compliance_review",
      "errorCode": "insufficient_funds",
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "networkFees": {
        "amount": "3.14",
        "currency": "USD",
        "feePayer": "endUser"
      },
      "paymentIntentId": "6e4d4047-db14-4c09-b238-1215aee50d03",
      "customerExternalRef": "310c458a-18eb-4cbd-8a9a-586d9448ae69",
      "settlementAmount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "fromAddresses": {
        "chain": "ETH",
        "addresses": [
          "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
        ]
      },
      "depositAddress": {
        "chain": "ETH",
        "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f",
        "addressTag": "123456789"
      },
      "transactionHash": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906",
      "refundIds": [
        "8edc0da8-d086-3051-a393-53f972d16444"
      ],
      "paymentId": "36a25933-8c2d-3c23-ad07-7fe1e41b5fe5",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z",
      "riskEvaluation": {
        "decision": "approved",
        "reason": "3000"
      }
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

GET

payments

List all crypto payments

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/payments', 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/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "payment",
      "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
      "amount": {
        "currency": "USD",
        "amount": "3.14"
      },
      "status": "pending",
      "merchantWalletId": "1000662322",
      "statusReason": "compliance_review",
      "errorCode": "insufficient_funds",
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "networkFees": {
        "amount": "3.14",
        "currency": "USD",
        "feePayer": "endUser"
      },
      "paymentIntentId": "6e4d4047-db14-4c09-b238-1215aee50d03",
      "customerExternalRef": "310c458a-18eb-4cbd-8a9a-586d9448ae69",
      "settlementAmount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "fromAddresses": {
        "chain": "ETH",
        "addresses": [
          "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
        ]
      },
      "depositAddress": {
        "chain": "ETH",
        "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f",
        "addressTag": "123456789"
      },
      "transactionHash": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906",
      "refundIds": [
        "8edc0da8-d086-3051-a393-53f972d16444"
      ],
      "paymentId": "36a25933-8c2d-3c23-ad07-7fe1e41b5fe5",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z",
      "riskEvaluation": {
        "decision": "approved",
        "reason": "3000"
      }
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

paymentIntentId

string<uuid>

Queries items with the specified payment intent ID.

Example:

"b48c8962-8e9f-40c3-9f1d-d9adde2ffe61"

paymentType

enum<string>[]

Payment resource type. Filters the results to fetch only payments or only refunds. Matches any type if unspecified.

Available options:

payment,

refund

status

enum<string>

Queries items with the specified status. Matches any status if unspecified. Enumerated status of the payment. pending means the payment is waiting to be processed. confirmed means the payment has been approved and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. paid means settlement funds have been received and are available to the merchant. failed means something went wrong. action_required means that additional steps are required to process this payment. Terminal states are paid and failed.

Available options:

pending,

confirmed,

paid,

failed,

action_required

walletId

string

The accountId of the custody account to list payments for. Without this filter, a Digital Asset Accounts distributor key returns only payments on the distributor's own entity. To list an end user's payments, pass the accountId of the end user's custody account. The account must belong to the caller; otherwise the request is rejected.

Example:

"1000662322"

from

string

Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

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

string

Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.

Example:

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

pageBefore

string

A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

Example:

"def9520a-5280-4089-9b02-3c9ef8fc8514"

pageAfter

string

A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

Example:

"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"

pageSize

integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If omitted, the collection will determine the page size itself.

Required range: x >= 1

Example:

5

Response

Successfully retrieved a list of payments.

data

object[]

Show child attributes