Skip to main content
POST
/
v1
/
tenant
/
international
/
payouts
/
process
(Deprecated) Submit a Uniteller payout via the provider-shaped payload
curl --request POST \
  --url https://api.sandbox.finogates.com/v1/tenant/international/payouts/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderPartnerID": "<string>",
  "orderCurrency": "<string>",
  "orderAmount": 123,
  "payoutBranchID": 123,
  "payoutCurrency": "<string>",
  "payoutAmount": 123,
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payee_payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary": {
    "partnerId": "",
    "firstName": "",
    "middleName": "",
    "lastName": "",
    "maidenName": "",
    "phone": "",
    "dateOfBirth": "",
    "nationality": "",
    "gender": "",
    "email": "",
    "document": {
      "number": "",
      "type": "",
      "issueCountry": "",
      "issueDate": "",
      "dueDate": "",
      "issuer": ""
    },
    "address": {
      "state": "",
      "city": "",
      "streetAndNumber": ""
    }
  },
  "bankInfo": {
    "bankDocument": "",
    "bankAccount": "",
    "bankAccType": "",
    "bankBranch": ""
  },
  "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender": {
    "partnerId": "",
    "name": "",
    "type": "",
    "registrationNumber": "",
    "email": "",
    "phone": "",
    "address": {
      "state": "",
      "city": "",
      "streetAndNumber": ""
    },
    "legalRepresentation": {
      "firstName": "",
      "lastName": "",
      "phone": "",
      "email": "",
      "document": {
        "type": "",
        "number": "",
        "issueCountry": ""
      }
    },
    "nature": "",
    "registrationDate": ""
  }
}
'
{
  "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

​
payment_method_id
string | null

(Legacy) UUID of the bank payment method used

Body

application/json

Request body for POST /tenant/international/payouts/process.

Sender is server-managed. API consumers never need to supply sender / business-identity fields. Finogates resolves the sender block from the SUA-configured platform defaults (Tenant.meta['uniteller_sender_defaults']) and injects it into the outbound provider call. This is part of the Finogates orchestration contract — provider-specific mandatory fields are enriched server-side, never required from the customer.

The endpoint accepts two shapes:

  • Canonical (preferred) — product_id + payee_payment_method_id. Routes through ensure_tenant_product_entitled → select_provider → reserve_funds → ensure_payment_method_binding → provider call → move_escrow_to_clearing / release_escrow. Beneficiary and bank info are loaded from the saved PaymentMethod (and optionally a linked InternationalBeneficiary).
  • Legacy (deprecated) — inline beneficiary + bankInfo. Bypasses the entitlement / ledger / binding pipeline. New integrations MUST use the canonical shape; the legacy shape is retained only to avoid breaking the integration that just shipped.

Exactly one of the two shapes must be present.

Internal/advanced fields (not part of the public surface, retained for backward compatibility):

  • sender_id — explicitly select a saved InternationalSender row instead of falling back to the platform defaults. Tenant-managed by SUA; most integrators leave this unset.
  • sender — inline override of the sender block. Deprecated and ignored by default: server-side enrichment runs whenever the enrichment dispatcher returns a populated block, so this field is effectively only honored when the platform has no defaults configured.
​
orderPartnerID
string
required
Maximum string length: 32
​
orderCurrency
string
required
Required string length: 3
​
orderAmount
number
required
​
payoutBranchID
integer
required
​
payoutCurrency
string
required
Required string length: 3
​
payoutAmount
number | null
​
product_id
string<uuid> | null
​
payee_payment_method_id
string<uuid> | null
​
beneficiary
MoreBeneficiary · object
​
bankInfo
MoreBankInfo · object
​
sender_id
string<uuid> | null

(Internal) Explicit saved-sender override. Leave unset to use platform defaults.

​
sender
MoreSender · object

(Deprecated) Inline sender override. Server-side enrichment from platform defaults takes precedence.

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.