Get user attributes for destination_token

get

https://{environment}.masspay.io/{VERSION}/attribute/{user_token}/{endpoint_token}/{currency}

This GET endpoint is used to retrieve user attributes for a specific destination token.
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.
To use this endpoint, you need to provide the user_token, endpoint_token, and currency as parameters in the URL Path.
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.

Path Params

user_token

string

required

Token representing the user to retrieve attributes for

endpoint_token

string

required

Token representing the transaction endpoint — either the destination_token for payouts (e.g., MassPay → Brazil → Bank Deposit → Itau), or the origin_token for pay-ins. For payouts, this value is retrieved from the country services endpoint.

currency

string

required

length between 3 and 5

The destination currency sending funds to. Using ISO 4217 format.

Query Params

show_latest_attr_set_token

boolean

Defaults to true

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_labels

boolean

Defaults to false

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_attributes

boolean

Defaults to false

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

Headers

Idempotency-Key

string

Unique key to prevent duplicate processing

Language

string

length between 2 and 2

Defaults to en

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

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.