Payment Request Flow APIs

get

Get payment creation field specifications

Path parameters

identityReferencestringRequired

Query parameters

beneficiaryAccountIdOptionalstring · uuidOptional

Responses

200

Response to /api/v1/fields/{identityReference}/payment

application/json

get

/api/v1/fields/{identityReference}/payment

HTTPcURLJavaScriptPython

GET /api/v1/fields/{identityReference}/payment HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/fields/{identityReference}/payment

{
  "spec": {
    "ANY_ADDITIONAL_PROPERTY": {
      "field_groups": [
        {
          "fields": [
            {
              "additional_info": {
                "link": "text",
                "localized_text": "text"
              },
              "input": {
                "constraints": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "key": "text",
                "options": [
                  {
                    "key": "text",
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                ],
                "required_conditions": [
                  {
                    "depends_on": "text",
                    "selected_option": "text",
                    "selected_options": [
                      "text"
                    ],
                    "type": "text"
                  }
                ],
                "tags": [
                  "text"
                ],
                "type": "text"
              },
              "input_pattern": "text",
              "localized_hint": "text",
              "localized_name": "text",
              "option_decorations": [
                {
                  "key": "text",
                  "localized_name": "text"
                }
              ],
              "tags": [
                "text"
              ],
              "visibility_conditions": [
                {
                  "depends_on": "text",
                  "selected_option": "text",
                  "selected_options": [
                    "text"
                  ],
                  "type": "text"
                }
              ]
            }
          ],
          "localized_name": "text"
        }
      ],
      "field_order": [
        "text"
      ]
    }
  }
}