Skip to main content
POST
/
v1
/
platform
/
payees
/
{payee_id}
/
destinations
Create Destination
curl --request POST \
  --url https://api.sandbox.finogates.com/v1/platform/payees/{payee_id}/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method_type": "bank",
  "rail_code": "<string>",
  "currency": "<string>",
  "nickname": "<string>",
  "recipient_email": "jsmith@example.com",
  "recipient_name": "<string>",
  "bank_account_number": "<string>",
  "routing_number": "<string>",
  "account_holder_name": "<string>",
  "bank_name": "<string>",
  "account_type": "<string>",
  "bank_country": "<string>",
  "bank_address": "<string>",
  "bank_city": "<string>",
  "bank_state": "<string>",
  "bank_zip": "<string>",
  "swift_bic": "<string>",
  "iban": "<string>",
  "intermediary_bank_name": "<string>",
  "intermediary_swift_bic": "<string>",
  "purpose_of_payment": "<string>",
  "beneficiary_type": "<string>",
  "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_reference": "<string>",
  "provider_token": "<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.

Path Parameters

​
payee_id
string<uuid>
required

Query Parameters

​
user_id
string<uuid>
required

Owner end-user UUID.

Body

application/json

Request body for attaching a destination to a payee.

For method_type="bank": supply either domestic (routing_number + bank_account_number) or international (swift_bic) fields.

For method_type="email": supply recipient_email + recipient_name. Bank fields are not required and ignored.

​
method_type
string
default:bank
Maximum string length: 30
​
rail_code
string | null
Maximum string length: 30
​
currency
string | null
Required string length: 3
​
nickname
string | null
Maximum string length: 120
​
recipient_email
string<email> | null
​
recipient_name
string | null
Required string length: 1 - 255
​
bank_account_number
string | null
Required string length: 4 - 34
​
routing_number
string | null
Required string length: 9
​
account_holder_name
string | null
Maximum string length: 120
​
bank_name
string | null
Maximum string length: 120
​
account_type
string | null
Maximum string length: 30
​
bank_country
string | null
Maximum string length: 2
​
bank_address
string | null
Maximum string length: 160
​
bank_city
string | null
Maximum string length: 120
​
bank_state
string | null
Maximum string length: 120
​
bank_zip
string | null
Maximum string length: 20
​
swift_bic
string | null
Required string length: 8 - 11
​
iban
string | null
Required string length: 15 - 34
​
intermediary_bank_name
string | null
Maximum string length: 120
​
intermediary_swift_bic
string | null
Required string length: 8 - 11
​
purpose_of_payment
string | null
Maximum string length: 120
​
beneficiary_type
string | null
Maximum string length: 20
​
provider_id
string<uuid> | null
​
provider_reference
string | null
Maximum string length: 120
​
provider_token
string | null
Maximum string length: 255
​
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.