Retrieve the required fields for a payment method

GET {{baseUrl}}/v1/payment_methods/:pmtId/required_fields

The fields are returned as a list of objects. The name of each field appears in the name field of the response

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":{"fields":[{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"number","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"string","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"}],"maximum_expiration_seconds":"\u003cnumber\u003e","minimum_expiration_seconds":"\u003cnumber\u003e","payment_method_options":[{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"string","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"string","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"}],"payment_options":[{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"number","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","is_required":"\u003cboolean\u003e","is_updatable":"\u003cboolean\u003e","instructions":"\u003cstring\u003e","name":"\u003cstring\u003e","numeric_code":"\u003cstring\u003e","required_fields":[{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Field detected\u003e"}],"type":"object","regex":"\u003cstring\u003e","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}