getSettlement

Circle Mint

Core Functionality

Balances

Payouts

Wires

CBIT

PIX

Transfers

Addresses

Deposits

Accounts API

Wallets

Transfers

API Overview

Health

Management

Encryption

Subscriptions

Stablecoins

Channels

Payments API

Payments

Pull Crypto Payments

Crypto Payment Intents

Cards

Payment Tokens

Settlements

Chargebacks

Balances

Checkout Sessions

Payouts API

Payouts

Crypto Address Book

Crypto Exchange Rates

Get a settlement

GEThttps://api.circle.com/v1/settlements/{id}

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Response

200GetSettlementResponse

Response Body

object

data

object

Show 9 properties

string

Unique system generated identifier for the entity.

merchantWalletId

string

Unique system generated identifier for the wallet of the merchant.

walletId

string

If this settlement was used for a marketplace payment, the wallet involved in the settlement. Not included for standard merchant settlements.

totalDebits

object

Show 2 properties

totalCredits

object

Show 2 properties

paymentFees

object

Show 2 properties

chargebackFees

object

Show 2 properties

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "merchantWalletId": "212000",
5    "walletId": "12345",
6    "totalDebits": {
7      "amount": "3.14",
8      "currency": "USD"
9    },
10    "totalCredits": {
11      "amount": "3.14",
12      "currency": "USD"
13    },
14    "paymentFees": {
15      "amount": "3.14",
16      "currency": "USD"
17    },
18    "chargebackFees": {
19      "amount": "3.14",
20      "currency": "USD"
21    },
22    "createDate": "2020-04-10T02:13:30.000Z",
23    "updateDate": "2020-04-10T02:13:30.000Z"
24  }
25}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy