Skip to main content
GET
/
v1
/
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": [
      {
        "field": "ORIGINATOR_FINANCIAL_INSTITUTION_NAME",
        "optional": false,
        "type": "TEXT",
        "values": [
          "value1",
          "value2",
          "value3"
        ]
      }
    ],
    "beneficiaryAccount": [
      {
        "field": "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.

Example:

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

Response

Payment requirements retrieved successfully.

​
data
object
required
⌘I