Get Payment Method Required Fields

Retrieve the required fields for a payment method.

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

Note

Rapyd employs a unique variant of regex. Note the following differences:
- A single backslash matches a backslash as an ordinary character.
- A backslash followed by an alphabetic character matches a string of two characters.
- A special character such as \n is indicated as \\n.
Some payment methods require a predefined customer with required fields. See also the example on this page.
Some payment methods require fields when certain conditions are met.

Parameters

Request Path Parameters

- type
- The type of the payment method.

Request Header Parameters

Response Parameters

- fields
- Contains several fields that are used in creating the specific payment method. These fields always contain the same value for a payment method, so they are included in the payment method object. To determine what fields you need for the payment method, see Get Payment Method Required Fields. For more fields, see the payment_options field in the response to List Payment Methods by Country. The fields object can contain only fields that are explicitly described as either required or optional. A field with an unknown name will throw an error.
  conditions
  Conditions that define whether the field is required.
  
  description
  Text explanation of the condition.
  element_name
  Name of the field that is conditionally required.
  operator
  Operator for evaluating the condition. When the condition evaluates to true, the field is required. One of the following:
  $eq - Equal to - The value in the field is equal to the threshold_value.
  $ne - Not equal to - The value in the field is not equal to the threshold_value.
  $gt - Greater than - The value in the field is greater than the threshold_value.
  $lt - Less than - The value in the field is less than the threshold_value.
  $gte - Greater than or equal to - The value in the field is greater than the threshold_value.
  $lte - Less than or equal to - The value in the field is less than the threshold_value.
  $in - In - The value in the field is equal to any of the values in the threshold_value array.
  $nin - Not in - The value in the field is not equal to any of the values in the threshold_value array.
  threshold_value
  Value to compare with. Can be a string or an array of strings.
  instructions
  Instructions for the field.
  is_required
  Indicates whether the field is required for using the payment method.
  true - Required.
  false - Optional.
  name
  Name of the field.
  regex
  A regular expression that defines the format when type is string.
  Note
  Rapyd uses a unique variant of the regex standard. See
  type
  Type of the field. One of the following values:
  boolean
  number
  string
- maximum_expiration_seconds
- The maximum time (in seconds) that the merchant can set for completing the payment. Relevant when is_expirable is true.
- minimum_expiration_seconds
- The minimum time (in seconds) that the merchant can set for completing the payment. Relevant when is_expirable is true.
- payment_method_options
- Additional fields required for the payment method. These values might vary from one use to the next, so they are not saved as part of the payment method object.
  In the request to create payment, these fields appear in the 'payment_method_options' object.
- payment_options
- Additional fields of the Payment object which are required for the payment.
  In the request to create payment, these fields appear in the root of the body of the request.
  To determine the fields, run Get Payment Method Required Fields.
- type
- Type of the payment method. For example, it_visa_card.
  To get a list of payment methods for a country, use List Payment Methods by Country.

Code Samples

.NET

using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string type = "us_visa_card";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payment_methods/required_fields/{type}");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest('GET', '/v1/payment_methods/required_fields/us_visa_card');

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', '/v1/payment_methods/required_fields/us_visa_card');
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

payment_method_type = "us_visa_card"
response = make_request(method='get',
                        path=f'/v1/payment_methods/required_fields/{payment_method_type}')
pprint(response)

/v1/payment_methods/required_fields/{type}

Card

curl -X get
https://sandboxapi.rapyd.net/v1/payment_methods/required_fields/us_visa_card
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "80df644d-c428-4588-9f18-9698a25bbe5d"
    },
    "data": {
        "type": "us_visa_card",
        "fields": [
            {
                "name": "number",
                "type": "string",
                "regex": "",
                "is_required": true,
                "instructions": "card number"
            },
            {
                "name": "expiration_month",
                "type": "string",
                "regex": "",
                "is_required": true,
                "instructions": "expiration month as string, 01-12"
            },
            {
                "name": "expiration_year",
                "type": "string",
                "regex": "",
                "is_required": true,
                "instructions": "expiration year in to digits as string, 18-99"
            },
            {
                "name": "cvv",
                "type": "string",
                "regex": "",
                "is_required": false,
                "instructions": "card cvv"
            },
            {
                "name": "name",
                "type": "string",
                "regex": "",
                "is_required": false,
                "instructions": "card holder name"
            },
            {
                "name": "address",
                "type": "Address",
                "regex": "",
                "is_required": false,
                "instructions": "card billing address. see Address object for more details"
            }
        ],
        "payment_method_options": [
            {
                "name": "3d_required",
                "type": "string",
                "regex": "",
                "description": "",
                "is_required": false,
                "is_updatable": false
            }
        ],
        "payment_options": [
            {
                "name": "customer",
                "type": "customer",
                "regex": "",
                "description": "make sure a customer was created with first_name, last_name and email",
                "is_required": true,
                "is_updatable": false
            }
        ],
        "minimum_expiration_seconds": null,
        "maximum_expiration_seconds": null
    }
}

Cash

curl -X get
https://sandboxapi.rapyd.net/v1/payment_methods/required_fields/it_psc_cash
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "48d8e711-69ad-46b7-804c-d3c06fdb262b"
    },
    "data": {
        "type": "it_psc_cash",
        "fields": [],
        "payment_method_options": [],
        "payment_options": [],
        "minimum_expiration_seconds": null,
        "maximum_expiration_seconds": null
    }
}

Bank Transfer

curl -X get
https://sandboxapi.rapyd.net/v1/payment_methods/required_fields/us_ach_bank
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "6027b9d1-f40a-481e-a89e-4934290222db"
    },
    "data": {
        "type": "us_ach_bank",
        "fields": [
            {
                "name": "proof_of_authorization",
                "type": "boolean",
                "regex": "",
                "description": "Indicates that the requester has received authorization from the payor.",
                "is_required": true,
                "is_updatable": false
            },
            {
                "name": "first_name",
                "type": "string",
                "regex": "",
                "description": "First name of the payor.",
                "is_required": false,
                "is_updatable": false
            },
            {
                "name": "last_name",
                "type": "string",
                "regex": "",
                "description": "Last name of the payor.",
                "is_required": false,
                "is_updatable": false
            },
            {
                "name": "company_name",
                "type": "string",
                "regex": "",
                "description": "Company name, when the payor is a business organization.",
                "is_required": false,
                "is_updatable": false
            },
            {
                "name": "routing_number",
                "type": "string",
                "regex": "^([0-9]){9,9}$",
                "description": "Bank routing number.",
                "is_required": true,
                "is_updatable": false
            },
            {
                "name": "payment_purpose",
                "type": "string",
                "regex": "(PAYMENT|VENDOR PMT)",
                "description": "Purpose of the payment.",
                "is_required": true,
                "is_updatable": false
            },
            {
                "name": "account_number",
                "type": "string",
                "regex": "^([0-9]){1,34}$",
                "description": "The payors bank account number.",
                "is_required": true,
                "is_updatable": false
            }
        ],
        "payment_method_options": [],
        "payment_options": [],
        "minimum_expiration_seconds": null,
        "maximum_expiration_seconds": null
    }
}

Customer with Required Fields

curl -X get
https://sandboxapi.rapyd.net/v1/payment_methods/required_fields/gb_trustly_bank
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "5f25e66f-e7e7-49c5-bb9e-a7c68734adfc"
    },
    "data": {
        "type": "gb_trustly_bank",
        "fields": [],
        "payment_method_options": [],
        "payment_options": [
            {
                "name": "customer",
                "type": "customer",
                "regex": "",
                "description": "ID of a customer object, a string starting with ‘cus_‘. The customer object must contain the fields listed as required, and can contain additional fields listed here.If the customer object does not exist yet, use ‘Create Customer‘",
                "is_required": true,
                "is_updatable": false,
                "required_fields": [
                    {
                        "name": "name",
                        "type": "string",
                        "regex": "^[0-9a-zA-Z ]{1,128}$",
                        "description": "Customer’s full name",
                        "is_required": true,
                        "is_updatable": false
                    },
                    {
                        "name": "email",
                        "type": "string",
                        "regex": "^(?=.{1,100}$)([0-9a-zA-Z_]+@[a-zA-Z_]+?[.]{1}[a-zA-Z]{2,3})$",
                        "description": "Customer’s Email",
                        "is_required": true,
                        "is_updatable": false
                    }
                ]
            }
        ],
        "minimum_expiration_seconds": 0,
        "maximum_expiration_seconds": 1209600
    }
}

In this section:

Documentation

Get Payment Method Required Fields

Note

Parameters

Request Path Parameters

Request Header Parameters

Response Parameters

Note

Code Samples

Search results