---
title: "Get all stored user attributes"
method: GET
path: "/payout/attribute/{user_token}"
tags: ["Attribute"]
deprecated: true
---

# Get all stored user attributes

`GET /payout/attribute/{user_token}`

## Request

- Base URL: `https://api.masspay.io/v1.0.0`
- URL: `https://api.masspay.io/v1.0.0/payout/attribute/{user_token}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/masspay/apis/masspay-api/docs/payout/attribute/:user_token/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

This **GET** endpoint is used to retrieve all stored user attributes for all 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` as parameters in the URL Path. <br> The endpoint will then return all the stored attributes for the provided user in the context of the destination token. If multiple `attribute set tokens` are available, all the sets and their values will be returned.

## Path parameters

- `user_token` string, required

## Query parameters

- `show_translated_labels` boolean

## Headers

- `Idempotency-Key` string
- `Language` string

## Response `200`

successful operation

- AllAttributesResp[]
  - `destination_token` string, uuid: Token that represents the payout destination. 36 characters long
  - `payer_logo` string, byte: base64 representation of the payer logo
  - `payer_name` string: Name of payer
  - `exchange_rate` object[]: Lists all available currencies and their estimated rates
    - `currency_symbol` string, required: Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
    - `exchange_rate` number, double, required: Estimated rate
  - `max_limit` number, double: The maximum amount (inclusive) the user can send with this service. 0 if no upper limit
  - `min_limit` number, double: The minimum amount (inclusive) the user can send with this service. 0 if no lower limit
  - `number_of_locations` integer: Total number of locations. Mostly relevant for cash pickup services. 0 if unknown or irrelevant
  - `estimated_availability` string, date-time: Estimated availability of funds. When funds would be available to pickup/deposited
  - `additional_description` string: When available, additional description that explains the service offered or requirements for funds delivery.
  - `is_dynamic_token` boolean: When set to true, it indicates that this destination_token will auto retry the transaction for a set time until it is successful or timesout. False value means the transaction will be processed by the payer in real-time with instant feedback on success/failure.
  - `attributes` AttrsRequirement[]
    - `token` string, required: The token that represents the attribute.
    - `attr_set_token` string: 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.
    - `label` string, required: The label that describes that required attribute
    - `validation` string, required: RegEx that validates that input
    - `is_optional` boolean, required: Flag to indicate whether this field is required or not
    - `value` string: The existing value that is stored. 'Null' if no existing value is stored.
    - `expected_value` string: 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_used` boolean: 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

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `405`: Method Not Allowed.
- `500`: Internal server error.
- `504`: Gateway Time-out.

## Changes

- **2026-11-03** `f9fa41b7c45c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/masspay/apis/masspay-api/changes/payout/attribute/:user_token/get.md)

---

[API](https://skmtc.dev/masspay/apis/masspay-api.md) - [All operations](https://skmtc.dev/masspay/apis/masspay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/masspay/apis/masspay-api/revisions/f9fa41b7c45c?raw)