Skip to main content
POST
/
v1
/
platform
/
payees
Create Payee
curl --request POST \
  --url https://api.sandbox.finogates.com/v1/platform/payees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "metadata": {}
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Documentation Index

Fetch the complete documentation index at: https://developer.finogates.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

user_id
string<uuid>
required

Owner end-user UUID.

Body

application/json

Request body for POST /tenant/payees.

display_name
string
required
Required string length: 1 - 255
email
string<email> | null
phone
string | null
Maximum string length: 40
metadata
Metadata · object

Response

Successful Response

Standard response wrapper for single-object responses and errors.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.