Skip to main content

​
Overview

Payment requests allow users to request money from other FLEX users across the entire ecosystem. Recipients can accept, decline, or let the request expire.
All payment request endpoints require customer authentication (Bearer token).
Complete API Specification: View the full SSO OpenAPI Spec for detailed schemas and all endpoint specifications.

​
Payment Request Endpoints

Create Request

POST /sso/payment-transfer - Create a payment request

List Requests

GET /sso/payment-transfer - Get paginated payment requests

Get Request

GET /sso/payment-transfer/{id} - Get payment request by ID

Accept Request

POST /sso/payment-transfer/{id}/accept - Accept and execute payment

Decline Request

POST /sso/payment-transfer/{id}/decline - Decline payment request

Cancel Request

POST /sso/payment-transfer/{id}/cancel - Cancel payment request

​
Payment Request Lifecycle

1

Create

Initiator creates a payment request for a specific payer
2

Notify

Payer receives notification of the request
3

Action

Payer can accept, decline, or let it expire
4

Complete

If accepted, payment is automatically executed

​
Request Statuses

  • Pending: Awaiting payer action
  • Accepted: Payer accepted and payment completed
  • Declined: Payer declined the request
  • Cancelled: Initiator cancelled the request
  • Expired: Request expired before action

​
Key Features

​
Cross-Partner Requests

Create payment requests for any PayTag user on FLEX, regardless of which partner they come from.

​
Role-Based Filtering

Filter payment requests by role:
  • Initiator: Requests you’ve sent
  • Payer: Requests you’ve received

​
Duration Control

Set custom expiration times for payment requests.

Integration Guide

Implementation examples

Transaction API

Direct payment transfers

PayTag API

Search for recipients

OpenAPI Spec

Full API specification

​
Security

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