Skip to main content
POST
/
v1
/
platform
/
payees
Add a Payee
curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/payees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "payments@acme-supplier.com",
  "first_name": "Acme",
  "last_name": "Supplier",
  "phone": "+14155550123"
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

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

The unique ID of the user who owns this payee.

Body

application/json

Request body for POST /tenant/payees.

​
first_name
string
required
Required string length: 1 - 255
​
last_name
string
required
Required string length: 1 - 255
​
middle_name
string | null
Maximum string length: 255
​
maiden_name
string | null
Maximum string length: 255
​
date_of_birth
string | null
Maximum string length: 20
​
nationality
string | null
Maximum string length: 10
​
gender
string | null
Maximum string length: 1
​
doc_number
string | null
Maximum string length: 100
​
doc_type
string | null
Maximum string length: 50
​
doc_issue_country
string | null
Maximum string length: 10
​
doc_issue_date
string | null
Maximum string length: 20
​
doc_due_date
string | null
Maximum string length: 20
​
doc_issuer
string | null
Maximum string length: 255
​
state
string | null
Maximum string length: 255
​
city
string | null
Maximum string length: 255
​
street
string | null
Maximum string length: 500
​
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.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

​
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.