Get settlement instructions

curl --request GET \
  --url https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "currency": "MXN",
    "fiatAccountType": "wire",
    "instruction": {
      "trackingRef": "CIR13FB13A",
      "beneficiary": {
        "name": "CIRCLE INTERNET FINANCIAL INC",
        "address1": "99 HIGH STREET",
        "address2": "BOSTON MA 02110"
      },
      "beneficiaryBank": {
        "name": "WELLS FARGO BANK",
        "swiftCode": "WFBIUS6SXXX",
        "routingNumber": "121000248",
        "accountNumber": "****7427",
        "currency": "USD",
        "address": "4250 EXECUTIVE SQUARE SUITE 300",
        "city": "LA JOLLA",
        "postalCode": "02110",
        "country": "US"
      }
    }
  }
}

GET

exchange

trades

settlements

instructions

{currency}

Get settlement instructions

curl --request GET \
  --url https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "currency": "MXN",
    "fiatAccountType": "wire",
    "instruction": {
      "trackingRef": "CIR13FB13A",
      "beneficiary": {
        "name": "CIRCLE INTERNET FINANCIAL INC",
        "address1": "99 HIGH STREET",
        "address2": "BOSTON MA 02110"
      },
      "beneficiaryBank": {
        "name": "WELLS FARGO BANK",
        "swiftCode": "WFBIUS6SXXX",
        "routingNumber": "121000248",
        "accountNumber": "****7427",
        "currency": "USD",
        "address": "4250 EXECUTIVE SQUARE SUITE 300",
        "city": "LA JOLLA",
        "postalCode": "02110",
        "country": "US"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

currency

enum<string>

required

Fiat currency name.

Available options:

BRL,

MXN

Response

Successfully retrieved settlement instructions.

data

object

Option 1
Option 2

Show child attributes

data.currency

enum<string>

Available options:

MXN

data.fiatAccountType

enum<string>

The destination bank account type.

Available options:

wire,

cubix

data.instruction

object

Show child attributes

data.instruction.trackingRef

string

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

Example:

"CIR13FB13A"

data.instruction.beneficiary

object

Show child attributes

data.instruction.beneficiary.name

string

Name of the beneficiary.

Example:

"CIRCLE INTERNET FINANCIAL INC"

data.instruction.beneficiary.address1

string

Address line 1 of the beneficiary's address.

Example:

"99 HIGH STREET"

data.instruction.beneficiary.address2

string

Address line 2 of the beneficiary's address.

Example:

"BOSTON MA 02110"

data.instruction.beneficiaryBank

object

Show child attributes

data.instruction.beneficiaryBank.name

string

Name of the beneficiary's bank.

Example:

"WELLS FARGO BANK"

data.instruction.beneficiaryBank.swiftCode

string

SWIFT code of the beneficiary's bank account.

Example:

"WFBIUS6SXXX"

data.instruction.beneficiaryBank.routingNumber

string

ABA Routing number of the beneficiary's bank account.

Example:

"121000248"

data.instruction.beneficiaryBank.accountNumber

string

Account number of the beneficiary's bank account.

Example:

"****7427"

data.instruction.beneficiaryBank.currency

string

Currency of the beneficiary's bank account.

Example:

"USD"

data.instruction.beneficiaryBank.address

string

Address of the beneficiary's bank.

Example:

"4250 EXECUTIVE SQUARE SUITE 300"

data.instruction.beneficiaryBank.city

string

City of the beneficiary's bank.

Example:

"LA JOLLA"

data.instruction.beneficiaryBank.postalCode

string

Postal code of the beneficiary's bank.

Example:

"02110"

data.instruction.beneficiaryBank.country

string

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

Example:

"US"

Get settlement

Create a mock PIX payment

Core API

API Overview

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Get settlement instructions

Authorizations

Path Parameters

Response