MAmasspay
Attribute

Get user attributes for destination_token

Changed on

This GET endpoint is used to retrieve user attributes for a specific destination token. <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, destination_token, and currency as parameters in the URL Path. <br> The endpoint will then return all the required attributes for the provided user for the specified destination token. If any of the attributes already have a stored value, it will be returned as well.

get/payout/attribute/{user_token}/{destination_token}/{currency}

Request

Path parameters

user_tokenstring required

Token representing the user to retrieve attributes for

destination_tokenstring required

Token that represents the payout destination i.e. MassPay->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback.

Query parameters

show_latest_attr_set_tokenboolean

When set to true, will only return the values associated with the latest attr_set_token used. If none were used, it will return all

show_translated_labelsboolean

When set to true, the language that is set on the user profile will be used to display the labels and expected values. When false, English labels will be used.

include_completed_global_attributesboolean

If true, returns completed global attributes (e.g., SSN, ID number). By default, completed global attributes are excluded.

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Languagestring
Example:en

When provided, it is used in conjunction with show_translated_labels and overrides the language setting of the user profile

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