Skip to main content

Overview

PayTag endpoints allow you to search for FLEX users and resolve PayTag details across the entire ecosystem, regardless of which partner created the PayTag.
All PayTag endpoints require customer authentication (Bearer token).
Complete API Specification: View the full SSO OpenAPI Spec for detailed schemas and all endpoint specifications.

PayTag Endpoints

Search PayTags

GET /sso/paytag/search - Search for PayTags by name, email, phone, or tag

Resolve PayTag

GET /sso/paytag/{tag} - Get PayTag profile details

Connected Partners

GET /sso/paytag/{tag}/partners - List partners connected to a PayTag

Key Features

Search and discover PayTag users across the entire FLEX ecosystem, enabling truly interconnected payments.

Profile Resolution

Get detailed profile information for any PayTag user to display in your application before initiating transfers.

Partner Discovery

See which partners a PayTag user is connected to through wallet provisioning.

Use Cases

Recipient Lookup

Search for recipients before initiating transfers

Profile Display

Show user profiles in your application

Partner Discovery

Show which partners a user is connected to

Contact Suggestions

Provide search suggestions as user types

Search Capabilities

The PayTag search endpoint supports searching by:
  • PayTag (e.g., @johndoe)
  • User name
  • Email address
  • Phone number
Results are paginated for optimal performance.

Transaction API

Send money to searched PayTags

Beneficiary API

Save frequent recipients

Integration Guide

Implementation examples

OpenAPI Spec

Full API specification

Security

All PayTag endpoints require:
  • x-client-id header (Partner ID)
  • x-api-key header (Partner API key)
  • Authorization: Bearer {customer_token} header

Error Responses

API Tags

The PayTag API includes endpoints under the SSO PayTag tag in the OpenAPI specification.
For complete request/response schemas, parameters, and examples, refer to the SSO OpenAPI Specification.