API Reference

Get payment requirements for a quote

gethttps://api.circle.com/v1/cpn/payments/requirements

  • Reference
  • Playground

Retrieves the PII fields needed to collect to make this payment (travel rule and beneficiary account data).

Query parameters
quoteId
uuid
Required

The quote id that was created previously. The ID of the selected quote. The quote cannot be reused across multiple payments.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "travelRule": [
4      {
5        "field": "ORIGINATOR_FINANCIAL_INSTITUTION_NAME",
6        "optional": false,
7        "type": "TEXT",
8        "values": [
9          "value1",
10          "value2",
11          "value3"
12        ]
13      }
14    ],
15    "beneficiaryAccount": [
16      {
17        "field": "BANK_NAME",
18        "optional": true,
19        "type": "TEXT",
20        "values": [
21          "value1",
22          "value2",
23          "value3"
24        ]
25      }
26    ]
27  }
28}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.