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

200PaymentRequirementsResponse

Response Body

object

data

object

Required

Show 2 properties

travelRule

array of objects

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

Show 4 properties

field

string

Required

The name of the field that needs to be collected

Allowed valuesORIGINATOR_FINANCIAL_INSTITUTION_NAMEORIGINATOR_FINANCIAL_INSTITUTION_ADDRESSORIGINATOR_FINANCIAL_INSTITUTION_IDORIGINATOR_NAMEORIGINATOR_ACCOUNT_NUMBERORIGINATOR_ADDRESSORIGINATOR_DATE_OF_BIRTHORIGINATOR_NATIONALITYORIGINATOR_NATIONAL_IDENTIFICATION_NUMBERBENEFICIARY_NAMEBENEFICIARY_ADDRESSBENEFICIARY_DATE_OF_BIRTHBENEFICIARY_NATIONALITYBENEFICIARY_NATIONAL_IDENTIFICATION_NUMBERORIGINATOR_DATE_OF_FORMATIONORIGINATOR_COUNTRY_OF_FORMATIONBENEFICIARY_DATE_OF_FORMATIONBENEFICIARY_COUNTRY_OF_FORMATION

optional: boolean

type

string

Required

Enumeration of all possible requirement field types

Allowed valuesTEXTADDRESSFILE

values

array of strings

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

beneficiaryAccount

array of objects

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

Show 4 properties

field

string

Required

The name of the field that needs to be collected

Allowed valuesBANK_NAMEBANK_ADDRESSBANK_CITYBANK_DISTRICTBANK_COUNTRYBANK_POSTAL_CODESWIFT_CODEROUTING_NUMBERIBANACCOUNT_NUMBERRECIPIENT_PHONE_COUNTRY_CODERECIPIENT_PHONE_NUMBER

optional: boolean

type

string

Required

Enumeration of all possible requirement field types

Allowed valuesTEXTADDRESS

values

array of strings

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

400BadRequestResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

401NotAuthorizedResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

403ForbiddenResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

404NotFoundResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

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?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy