API Reference

Get settlement instructions

gethttps://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency}

Reference
Playground

Returns settlement instructions for a specific currency.

Path parameters

currency

string

Required

Fiat currency name.

Response

200GetSettlementInstructionsResponse

Response Body

object

data

object

option 1: object

Show 3 properties

currency

string

Allowed valuesMXN

fiatAccountType

string

The destination bank account type.

Allowed valueswirecubix

instruction

object

Show 3 properties

trackingRef

string

Circle tracking reference that needs to be set in the wire reference field.

beneficiary

object

Show 3 properties

name

string

Name of the beneficiary.

address1

string

Address line 1 of the beneficiary's address.

address2

string

Address line 2 of the beneficiary's address.

beneficiaryBank

object

Show 9 properties

name

string

Name of the beneficiary's bank.

swiftCode

string

SWIFT code of the beneficiary's bank account.

routingNumber

string

ABA Routing number of the beneficiary's bank account.

accountNumber

string

Account number of the beneficiary's bank account.

currency

string

Currency of the beneficiary's bank account.

address

string

Address of the beneficiary's bank.

city

string

City of the beneficiary's bank.

postalCode

string

Postal code of the beneficiary's bank.

country

string

Country code of the beneficiary's bank. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

option 2: object

Show 3 properties

currency

string

Allowed valuesBRL

fiatAccountType

string

Allowed valuespix

instruction

object

Show 6 properties

ispb

string

branchCode

string

accountNumber

string

name

string

accountType

string

Beneficiary account type.

Allowed valuescheckingsavingssalaryprepaid

taxId

string

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "currency": "MXN",
4    "fiatAccountType": "wire",
5    "instruction": {
6      "trackingRef": "CIR13FB13A",
7      "beneficiary": {
8        "name": "CIRCLE INTERNET FINANCIAL INC",
9        "address1": "99 HIGH STREET",
10        "address2": "BOSTON MA 02110"
11      },
12      "beneficiaryBank": {
13        "name": "SILVERGATE BANK",
14        "swiftCode": "SIVGUS66XXX",
15        "routingNumber": "322286803",
16        "accountNumber": "****7427",
17        "currency": "USD",
18        "address": "4250 EXECUTIVE SQUARE SUITE 300",
19        "city": "LA JOLLA",
20        "postalCode": "02110",
21        "country": "US"
22      }
23    }
24  }
25}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy