/v2/reference/payer_required_details

GET

Get information on the minimum details required to create a payer. Requirements vary depending on the location of the payer, the type of payment to be made (priority or regular), and other factors.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescriptionEnum
X-Auth-Token header string Authentication token.
payer_country query string Two-letter country code.
Optional
NameInTypeDescriptionEnum
payer_entity_type query string Legal entity. company
individual
payment_type query string Currencycloud supports two types of payments: "priority", made using the SWIFT network; and "regular", made using the local bank network. priority
regular
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/payer_required_details

Response

{
    "details": [
        {
            "payer_entity_type": "company",
            "payment_type": "priority",
            "required_fields": [
                {
                    "name": "payer_country",
                    "validation_rule": "^[A-z]{2}$"
                },
                {
                    "name": "payer_city",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_address",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_company_name",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_identification_value",
                    "validation_rule": "^.{1,255}"
                }
            ],
            "payer_identification_type": "incorporation_number"
        },
        {
            "payer_entity_type": "individual",
            "payment_type": "priority",
            "required_fields": [
                {
                    "name": "payer_country",
                    "validation_rule": "^[A-z]{2}$"
                },
                {
                    "name": "payer_city",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_address",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_first_name",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_last_name",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_date_of_birth",
                    "validation_rule": "\/A([+-]?d{4}(?!d{2}\b))((-?)((0[1-9]|1[0-2])(\u0003([12]d|0[1-9]|3[01]))?|W([0-4]d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]d|[12]d{2}|3([0-5]d|6[1-6])))([T ]((([01]d|2[0-3])((:?)[0-5]d)?|24:?00)([.,]d+(?!:))?)?(\u000f[0-5]d([.,]d+)?)?([zZ]|([+-])([01]d|2[0-3]):?([0-5]d)?)?)?)?Z\/"
                }
            ]
        },
        {
            "payer_entity_type": "company",
            "payment_type": "regular",
            "required_fields": [
                {
                    "name": "payer_country",
                    "validation_rule": "^[A-z]{2}$"
                },
                {
                    "name": "payer_city",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_address",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_company_name",
                    "validation_rule": "^.{1,255}"
                }
            ]
        },
        {
            "payer_entity_type": "individual",
            "payment_type": "regular",
            "required_fields": [
                {
                    "name": "payer_country",
                    "validation_rule": "^[A-z]{2}$"
                },
                {
                    "name": "payer_city",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_address",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_first_name",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_last_name",
                    "validation_rule": "^.{1,255}"
                },
                {
                    "name": "payer_date_of_birth",
                    "validation_rule": "\/A([+-]?d{4}(?!d{2}\b))((-?)((0[1-9]|1[0-2])(\u0003([12]d|0[1-9]|3[01]))?|W([0-4]d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]d|[12]d{2}|3([0-5]d|6[1-6])))([T ]((([01]d|2[0-3])((:?)[0-5]d)?|24:?00)([.,]d+(?!:))?)?(\u000f[0-5]d([.,]d+)?)?([zZ]|([+-])([01]d|2[0-3]):?([0-5]d)?)?)?)?Z\/"
                }
            ]
        }
    ]
}
Error Codes
HTTP Status Code Description Params
400 payer_country_is_required payer_country is required
payer_country_is_in_invalid_format payer_country is not a valid ISO 3166-1 Alpha-2 country code { "type" => "country_code" }
payment_type_not_in_range payment_type should be in range: priority, regular { "range" => "priority, regular" }
payer_entity_type_not_in_range payer_entity_type should be in range: company, individual { "range" => "company, individual" }
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this page helpful?
Yes
No