Skip to main content

​
Overview

Beneficiary endpoints allow customers to save frequently used PayTags for quick access during transfers, creating a seamless payment experience.
All beneficiary endpoints require customer authentication (Bearer token).
Complete API Specification: View the full SSO OpenAPI Spec for detailed schemas and all endpoint specifications.

​
Beneficiary Endpoints

Save Beneficiary

POST /sso/beneficiary/p2p - Save a PayTag as beneficiary

List Beneficiaries

GET /sso/beneficiary/p2p - Get saved beneficiary PayTags

Remove Beneficiary

DELETE /sso/beneficiary/p2p - Remove a beneficiary PayTag

​
Key Features

​
Quick Access

Save frequently used PayTags for one-tap transfers without searching each time.

​
Auto-Save During Transfer

Automatically save recipients as beneficiaries during P2P transfers by setting saveBeneficiary: true in the transaction request.

​
Cross-Partner Beneficiaries

Save any PayTag user across the FLEX ecosystem as a beneficiary, regardless of which partner created their account.

​
Use Cases

Quick Transfers

Enable one-tap transfers to frequent recipients

Recipient History

Show recently used recipients

Contact Book

Build beneficiary contact lists

Favorite Recipients

Let users mark favorite payment contacts

​
Auto-Save Example

When making a P2P transfer, automatically save the recipient as a beneficiary:

Transaction API

Send money to beneficiaries

PayTag API

Search for new beneficiaries

Integration Guide

Implementation examples

OpenAPI Spec

Full API specification

​
Security

All beneficiary 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 Beneficiary API includes endpoints under the SSO Beneficiary tag in the OpenAPI specification.
For complete request/response schemas, parameters, and examples, refer to the SSO OpenAPI Specification.