Get payment requirements for a quote

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

{
  "data": {
    "travelRule": [
      {
        "name": "ORIGINATOR_FINANCIAL_INSTITUTION_NAME",
        "optional": false,
        "type": "TEXT",
        "values": [
          "value1",
          "value2",
          "value3"
        ]
      }
    ],
    "beneficiaryAccount": [
      {
        "name": "BANK_NAME",
        "optional": true,
        "type": "TEXT",
        "values": [
          "value1",
          "value2",
          "value3"
        ]
      }
    ]
  }
}

GET

cpn

payments

requirements

Get payment requirements for a quote

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

{
  "data": {
    "travelRule": [
      {
        "name": "ORIGINATOR_FINANCIAL_INSTITUTION_NAME",
        "optional": false,
        "type": "TEXT",
        "values": [
          "value1",
          "value2",
          "value3"
        ]
      }
    ],
    "beneficiaryAccount": [
      {
        "name": "BANK_NAME",
        "optional": true,
        "type": "TEXT",
        "values": [
          "value1",
          "value2",
          "value3"
        ]
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Query Parameters

quoteId

string<uuid>

required

The quote id that was created previously. The ID of the selected quote. The quote cannot be reused across multiple payments. System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Response

Payment requirements retrieved successfully.

data

object

required

Show child attributes

data.travelRule

object[]

A list of travel rule fields needed to collect for the payment.

Show child attributes

data.travelRule.name

enum<string>

required

The name of the field that needs to be collected

Available options:

ORIGINATOR_FINANCIAL_INSTITUTION_NAME,

ORIGINATOR_FINANCIAL_INSTITUTION_ADDRESS,

ORIGINATOR_FINANCIAL_INSTITUTION_ID,

ORIGINATOR_NAME,

ORIGINATOR_ACCOUNT_NUMBER,

ORIGINATOR_ADDRESS,

ORIGINATOR_DATE_OF_BIRTH,

ORIGINATOR_NATIONALITY,

ORIGINATOR_NATIONAL_IDENTIFICATION_NUMBER,

BENEFICIARY_NAME,

BENEFICIARY_ADDRESS,

BENEFICIARY_DATE_OF_BIRTH,

BENEFICIARY_NATIONALITY,

BENEFICIARY_NATIONAL_IDENTIFICATION_NUMBER,

ORIGINATOR_DATE_OF_FORMATION,

ORIGINATOR_COUNTRY_OF_FORMATION,

BENEFICIARY_DATE_OF_FORMATION,

BENEFICIARY_COUNTRY_OF_FORMATION

Example:

"ORIGINATOR_FINANCIAL_INSTITUTION_NAME"

data.travelRule.optional

boolean

required

Whether the presence of this field is optional.

Example:

false

data.travelRule.type

enum<string>

required

Enumeration of all possible requirement field types

Available options:

TEXT,

ADDRESS,

FILE

Example:

"TEXT"

data.travelRule.values

string[]

An array of acceptable values for this field, if applicable.

Example:

["value1", "value2", "value3"]

data.beneficiaryAccount

object[]

The list of beneficiary account fields needed to send fiat money to the recipient in the final step.

Show child attributes

data.beneficiaryAccount.name

enum<string>

required

The name of the field that needs to be collected

Available options:

BANK_NAME,

BANK_ADDRESS,

BANK_CITY,

BANK_DISTRICT,

BANK_COUNTRY,

BANK_POSTAL_CODE,

SWIFT_CODE,

ROUTING_NUMBER,

IBAN,

ACCOUNT_NUMBER,

RECIPIENT_PHONE_COUNTRY_CODE,

RECIPIENT_PHONE_NUMBER

Example:

"BANK_NAME"

data.beneficiaryAccount.optional

boolean

required

Whether the presence of this field is optional.

Example:

true

data.beneficiaryAccount.type

enum<string>

required

Enumeration of all possible requirement field types

Available options:

TEXT,

ADDRESS

Example:

"TEXT"

data.beneficiaryAccount.values

string[]

An array of acceptable values for this field, if applicable.

Example:

["value1", "value2", "value3"]

Create a payment

Get a payment

API Overview

Circle Payments Network

Get payment requirements for a quote

Authorizations

Query Parameters

Response