API Reference

Get payment requirements for a quote

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

  • Reference
  • Playground

Retrieves the JSON schemas 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      "version": 1,
5      "schema": {
6        "schema": "https://json-schema.org/draft/2020-12/schema",
7        "title": "Travel Rule Requirements",
8        "type": "object",
9        "description": "Travel Rule Requirements",
10        "properties": {
11          "BENEFICIARY_ADDRESS": {
12            "ref": "#/defs/address"
13          },
14          "BENEFICIARY_DATE_OF_BIRTH": {
15            "description": "Date of birth of the beneficiary (YYYY-MM-DD)",
16            "type": "string"
17          },
18          "BENEFICIARY_NAME": {
19            "description": "Full name of the beneficiary",
20            "type": "string"
21          },
22          "BENEFICIARY_NATIONALITY": {
23            "description": "Nationality of the beneficiary",
24            "type": "string"
25          },
26          "BENEFICIARY_NATIONAL_IDENTIFICATION_NUMBER": {
27            "description": "National identification number of the beneficiary",
28            "type": "string"
29          },
30          "ORIGINATOR_ACCOUNT_NUMBER": {
31            "description": "Originator's account number",
32            "type": "string"
33          },
34          "ORIGINATOR_ADDRESS": {
35            "ref": "#/defs/address"
36          },
37          "ORIGINATOR_DATE_OF_BIRTH": {
38            "description": "Date of birth of the originator (YYYY-MM-DD)",
39            "type": "string"
40          },
41          "ORIGINATOR_FINANCIAL_INSTITUTION_ADDRESS": {
42            "ref": "#/defs/address"
43          },
44          "ORIGINATOR_FINANCIAL_INSTITUTION_ID": {
45            "description": "Identifier for the originator's financial institution",
46            "type": "string"
47          },
48          "ORIGINATOR_FINANCIAL_INSTITUTION_NAME": {
49            "description": "Name of the originator's financial institution",
50            "type": "string"
51          },
52          "ORIGINATOR_NAME": {
53            "description": "Full name of the originator",
54            "type": "string"
55          },
56          "ORIGINATOR_NATIONALITY": {
57            "description": "Nationality of the originator",
58            "type": "string"
59          },
60          "ORIGINATOR_NATIONAL_IDENTIFICATION_NUMBER": {
61            "description": "National identification number of the originator",
62            "type": "string"
63          }
64        },
65        "required": [
66          "ORIGINATOR_FINANCIAL_INSTITUTION_NAME",
67          "ORIGINATOR_FINANCIAL_INSTITUTION_ADDRESS",
68          "ORIGINATOR_NAME",
69          "ORIGINATOR_ACCOUNT_NUMBER",
70          "ORIGINATOR_ADDRESS",
71          "BENEFICIARY_NAME",
72          "BENEFICIARY_ADDRESS"
73        ],
74        "$defs": {
75          "address": {
76            "description": "Full address",
77            "properties": {
78              "city": {
79                "description": "City",
80                "type": "string"
81              },
82              "country": {
83                "description": "Country code (e.g. US, GB)",
84                "type": "string"
85              },
86              "postalCode": {
87                "description": "Postal or ZIP code",
88                "type": "string"
89              },
90              "stateProvince": {
91                "description": "State or province",
92                "type": "string"
93              },
94              "street": {
95                "description": "Street address",
96                "type": "string"
97              }
98            },
99            "required": [
100              "street",
101              "city",
102              "country"
103            ],
104            "type": "object"
105          }
106        }
107      }
108    },
109    "beneficiaryAccount": {
110      "version": 1,
111      "schema": {
112        "$schema": "https://json-schema.org/draft/2020-12/schema",
113        "title": "Beneficiary Account Data Requirements",
114        "type": "object",
115        "required": [
116          "RECIPIENT_ID_NUMBER"
117        ],
118        "properties": {
119          "RECIPIENT_EVP": {
120            "type": "string",
121            "description": "Recipient's EVP (random key)"
122          },
123          "RECIPIENT_EMAIL": {
124            "type": "string",
125            "format": "email",
126            "description": "Recipient's email address"
127          },
128          "RECIPIENT_ID_NUMBER": {
129            "type": "string",
130            "description": "Recipient's ID number"
131          },
132          "RECIPIENT_PHONE_NUMBER": {
133            "type": "string",
134            "description": "Recipient's phone number"
135          }
136        },
137        "description": "Beneficiary Account Data (PIX)",
138        "maxProperties": 2,
139        "additionalProperties": false
140      }
141    }
142  }
143}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.