Skip to main content
GET
/
v1
/
payments
List all payments
curl --request GET \
  --url https://api-sandbox.circle.com/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "payment",
      "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
      "merchantWalletId": "212000",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "fromAmount": {
        "amount": "3.14",
        "currency": "EUR"
      },
      "source": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "card"
      },
      "description": "Payment",
      "status": "pending",
      "captured": false,
      "captureAmount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "captureDate": "2020-04-10T02:13:30.000Z",
      "requiredAction": {
        "type": "three_d_secure_required",
        "redirectUrl": "https://example.org"
      },
      "cancel": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "cancel",
        "description": "Payment",
        "status": "pending",
        "createDate": "2020-04-10T02:13:30.000Z"
      },
      "refunds": [
        {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "payment",
          "amount": {
            "amount": "3.14",
            "currency": "USD"
          },
          "description": "Payment",
          "status": "pending",
          "requiredAction": {
            "type": "three_d_secure_required",
            "redirectUrl": "https://example.org"
          },
          "fees": {
            "amount": "3.14",
            "currency": "USD"
          },
          "createDate": "2020-04-10T02:13:30.000Z"
        }
      ],
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
source
string<uuid>

Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source.

Example:

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

​
settlementId
string<uuid>

Queries items with the specified settlement id. Matches any settlement id if unspecified.

Example:

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

​
paymentIntentId
string<uuid>

Queries items with the specified payment intent id.

Example:

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

​
type
enum<string>[]

Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified.

​
status
enum<string>

Queries items with the specified status. Matches any status if unspecified.

Available options:
pending,
confirmed,
paid,
failed,
action_required
​
from
string<date-time>

Queries items created since the specified date-time (inclusive).

Example:

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

​
to
string<date-time>

Queries items created before the specified date-time (inclusive).

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.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageAfter.

​
pageAfter
string

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageBefore.

​
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 avoided, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of payments.

​
data
array
  • Option 1
  • Option 2
  • Option 3
  • Option 4