# Parameters to a Create Donor source: https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md ## Method to Create a Donor {#method-to-create-a-donor} | Method | Endpoint | |--------|-------------------| | POST | /donations/donors | Note: The Entire Request Body has to be encrypted! For more details, refer to the [How to Encrypt](https://developer.mastercard.com/donations/tutorial/how-to-access-sandbox-environment/mastercard-encryption-decryption-mechanism/index.md) section. ## Request Parameters {#request-parameters} | Name | Type | Description | Notes | |-------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| | **userName** | string | Email address of the donor. Program specific. | **Required** | | **userType** | enum | The type of donor based on how they were enrolled into your donations program. Options include: **Partner for Other Online API Consumers** , **Batch for Offline Users** and **Online for Mastercard.** | **Required** | | **emails** | object | An object representing the donor's email addresses. See [Emails](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#emails) attributes. | **Required** | | **locale** | string | The donor's preferred locale (languages). Needs to validate for program country locale values. | **Required** | | **name** | object | An object representing the donor's name. See [Name](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#name) attributes. | **Required** | | **acceptedConsents** | object | An object representing the donor's legal consents. See [Accepted Consents](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#acceptedConsents) attributes. | **Required** | | **addresses** | object | The physical address associated with the donor's profile. See [Addresses](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#addresses) attributes. | Optional, but if passed, **type** , **streetAddress** and **country** are required. | | **timeZone** | string | The time zone associated with the donor's mailing address. Must be in [UTC time in ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. | Optional | | **title** | string | The title used to address the name of the donor. For example *Miss/Mr/Mrs*. | Optional | | **phoneNumbers** | object | An object representing the donor's phone numbers. See the [Phone Numbers](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#phoneNumbers) attributes. | Optional | | **password** | string | The password chosen by the donor when enrolling in your donations program. If passwords are sent in API Request body, they are stored in a PCI-Compliant space mapped to the donorId. | Optional | | **personalInformation** | object | An object representing the personalInformation. See [Personal Information](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#personalInformation) attributes. | Optional | ### Child Attributes {#child-attributes} #### emails {#emails} | Name | Type | Description | Notes | |-----------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **value** | string | The email address format must comply with standard limitations, specifically ensuring that the local part (the portion before the '@' symbol) does not exceed 64 characters. Additionally, the total length of the email address, including the '@' symbol and the domain, must not exceed 250 characters. | **Required** | | **type** | string | The type of email address. Allowed values are : *home* , *work* and *others* , with *home* provided for at least one email that is added. Username and home email should be same. | **Required** | #### name {#name} | Name | Type | Description | Notes | |---------------------|--------|--------------------------------------------------------------------------------------------------------------------------|---------------| | **firstName** | string | Donor's first name. Also known as given name. Alphabets, space (), hyphen (-) and apostrophe (') allowed. Max length 50. | **Required** | | **lastName** | string | Donor's last name. Also known as family name. Alphabets, space (), hyphen (-) and apostrophe (') allowed. Max length 50. | **Required**. | | **honorificPrefix** | string | Prefix that is added in front of the donor's name. | Optional | | **honorificSuffix** | string | Suffix added after the donor's first and last name. | Optional | #### acceptedConsents {#acceptedconsents} | Name | Type | Description | Notes | |------------------------------|--------|-------------------------------------------------------------------------------------------------------------|--------------| | **tncVersion** | string | The version number of the terms and conditions the cardholder accepted to enroll in your donations program. | **Required** | | **privacyNoticeVersion** | string | The version number of the privacy policy the cardholder accepted to enroll in your donations program. | **Required** | | **marketingEmailSubscribed** | string | Indicates if the donor has opted in to receive marketing email messages from your donations service. | **Required** | #### addresses {#addresses} | Name | Type | Description | Notes | |-------------------|--------|-------------------------------------------------------------------------------------------------------------------------|--------------| | **type** | string | The type of address. Allowed values are : *home* , *work* and *others*. | **Required** | | **formatted** | string | The donor's street address. | Optional | | **streetAddress** | string | The donor's street address. | **Required** | | **locality** | string | The city, district, suburb, town or village of the address. | Optional | | **region** | string | The donor's region. | Optional | | **postalCode** | string | The address's [postal code](https://en.wikipedia.org/wiki/Postal_code), which is the zip code or equivalent. | Optional | | **country** | string | The addresses country in three-character [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. | **Required** | #### phoneNumbers {#phonenumbers} | Name | Type | Description | Notes | |-----------|--------|-----------------------------------------------------------------------------|----------| | **type** | string | The type of phone number. Allowed values are : *home* , *work* and *others* | Optional | | **value** | string | The 11-digit phone number associated with the donor profile. | Optional | #### personalInformation {#personalinformation} | Name | Type | Description | Notes | |---------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | **identifications** | object | An object contains the donor's identifications details . See the [identifications](https://developer.mastercard.com/donations/documentation/parameters/enroll-manage-donor-param/enroll-donors-param/index.md#identifications) attributes. | Optional | #### identifications {#identifications} | Name | Type | Description | |-------------|--------|--------------------------------------| | **type** | string | Describe the identifications type. | | **value** | string | Describe the identifications number. | | **country** | string | Describe the country details. | ## Response Parameters {#response-parameters} A successful request returns the `HTTP 200 Created` status code and a JSON response body that includes a unique donor identifier. | Name | Type | Description | |--------------|--------|-----------------------------------------------------------------| | **donorId** | string | Unique ID generated by Mastercard when a new donor is enrolled. | | **userName** | string | The email address of the donor as sent in the request. |