Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Attribute

Get all stored user attributes

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.

get/attribute/{user_token}

Path parameters

user_tokenstring required

Token representing the user to retrieve attributes for

Query parameters

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.

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

destination_tokenstring uuid

Token that represents the payout destination. 36 characters long

payer_logostring byte

base64 representation of the payer logo

payer_namestring

Name of payer

max_limitnumber double

The maximum amount (inclusive) the user can send with this service. 0 if no upper limit

min_limitnumber double

The minimum amount (inclusive) the user can send with this service. 0 if no lower limit

number_of_locationsinteger

Total number of locations. Mostly relevant for cash pickup services. 0 if unknown or irrelevant

estimated_availabilitystring date-time

Estimated availability of funds. When funds would be available to pickup/deposited

additional_descriptionstring

When available, additional description that explains the service offered or requirements for funds delivery.

is_dynamic_tokenboolean

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.

Example response

[
  {
    "destination_token": "123e4567-e89b-12d3-a456-426614174000",
    "payer_logo": "U3dhZ2dlciByb2Nrcw==",
    "payer_name": "Elektra",
    "exchange_rate": [
      {
        "currency_symbol": "MXN",
        "exchange_rate": 18.37
      }
    ],
    "max_limit": 10000,
    "number_of_locations": 13007,
    "estimated_availability": "2020-07-21T17:32:28Z",
    "additional_description": "Requires drivers license to pickup funds",
    "attributes": [
      {
        "attr_set_token": "attr_set_e2ca24e9-c546-4c64-90d2-cb8e70e7c9ba",
        "label": "JPMorgan Chase",
        "attributes": [
          {
            "token": "attr_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"
          }
        ]
      }
    ]
  }
]