TRtransfi
Users

List Business Users

Changed on

Retrieve a paginated list of business users with optional filters.

get/v3/users/business

Request

Query parameters

pageinteger
Example:1

Page number

limitinteger
Example:10

Number of users per page

userIdstring
Example:UX-260105073228440

Filter by business user ID (exact match)

emailstring
Example:billing@example.com

Filter by business email

phonestring
Example:+14155550999

Filter by business phone

accountType'sender' | 'recipient_fiat' | 'recipient_crypto'
Example:sender

Filter by account role. sender returns sender accounts; recipient_fiat / recipient_crypto return users with at least one fiat / crypto account identifier. Applies only to users created through the sender or recipient creation APIs.

accountIdentifierValuestring
Example:1234567890

Filter by the value of a payout account identifier, such as a bank account number or a wallet address. Exact match. Applies only to users created through the sender or recipient creation APIs.

accountIdentifierType'bank_account' | 'iban' | 'e_wallet' | 'mobile_wallet' | 'crypto_wallet_address'
Example:bank_account

Filter by the type of a payout account identifier. When combined with accountIdentifierValue, both must match the same account identifier entry. Applies only to users created through the sender or recipient creation APIs.

Headers

MIDstring required
Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Response

Business users retrieved successfully

statusstring

Changes

  • 7b745621a79fRevision changes
    • info

      added the new optional query request parameter accountIdentifierType

    • info

      added the new optional query request parameter accountIdentifierValue

    • info

      added the new optional query request parameter accountType

    • info

      added the new optional query request parameter userId

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status