MAmasspay
Attribute

Get global user attributes

Changed on

This GET endpoint is used to retrieve all stored user global attributes. <br> You can use this endpoint to retrieve user attributes and provide personalized service to your users based on their preferences, demographic data, or other relevant information. <br> To use this endpoint, you need to provide the user_token as parameters in the URL Path. <br> The endpoint will then return all the stored global attributes for the provided user.

get/attribute/{user_token}/global

Request

Path parameters

user_tokenstring required

Token representing the user to retrieve attributes for

Query parameters

countrystring
Example:USA

Country code ISO_3166. When provided, it will obtain the global attributes for the country. If not provided, it will default to the country in the user profile

show_only_latest_attributesboolean

When set to true, it will only return the latest value stored for each attributes type, otherwise it will return all values

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

successful operation

tokenstring required

The token that represents the attribute.

attr_set_tokenstring

The token that represents the stored attributes for this payer. You would use this token in attr_set_token of initiatePayout if you have to specify an account number when paying a transaction out.

labelstring required

The label that describes that required attribute

validationstring required

RegEx that validates that input

is_optionalboolean required

Flag to indicate whether this field is required or not

valuestring

The existing value that is stored. 'Null' if no existing value is stored.

expected_valuestring

Written explanation of the value that the regex validation requires

type'CardNumber' | 'BankAccountType' | 'BankAccountNumber' | 'BankAccountBranchNumber' | 'BankName' | 'PhoneNumber' | 'Gender' | 'IdentificationNumber' | 'BillReferenceNumber' | 'BankRoutingNumber' | 'BankAccountName' | 'MaidenName' | 'SocialSecurity' | 'EmploymentName' | 'EmploymentAddress' | 'EmploymentPhone' | 'EmploymentOccupation' | 'EmploymentSupervisor' | 'RemittanceReason' | 'Relationship' | 'SecondLastName' | 'SWIFT' | 'BirthCountry' | 'SourceOfFunds' | 'DateOfBirth' | 'CardExpiration' | 'CardZip' | 'IdentificationType' | 'BankCity' | 'BankState' | 'IDSelfieCollection' | 'City' | 'Country' | 'IdentificationExpiration' | 'Address1' | 'IFramePaymentCollection' | 'PostalCode' | 'GuardianFullName' | 'GuardianGovIDType' | 'GuardianGovIDNumber' | 'GuardianConsent' | 'EIN' | 'WalletAddress' | 'OAuthGrant' | 'SecurityAnswer' required

The type of attribute

input_type'text' | 'options' | 'date' required

The type of input field that is suggested for this this attribute

last_attr_value_usedboolean

If set to true, it means this was the last value that was used and if no attr_set_token is provided to init payout, this value will be used by default

Example response

[
  {
    "token": "attr_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba",
    "attr_set_token": "attr_set_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba",
    "label": "Checking Account Number",
    "validation": "[0-9]{50}",
    "is_optional": true,
    "value": "432532532",
    "expected_value": "Date format MM/DD/YYYY",
    "type": "BankAccountNumber",
    "input_type": "text"
  }
]

Changes