name: Payouts
description: >-
  Send money from a merchant funded balance to a payee bank account or
  e-wallet in any EBANX-supported country. Supports local payouts in local
  currency and cross-border payouts where the merchant funds in USD and
  EBANX handles the FX conversion.
version: '1.0'
provider: ebanx
api: ebanx-payout-api
operations:
  - id: createPayout
    method: POST
    path: /ws/payout/create
    summary: Create Payout
  - id: commitPayout
    method: POST
    path: /ws/payout/commit
    summary: Commit Payout
  - id: cancelPayout
    method: POST
    path: /ws/payout/cancel
    summary: Cancel Payout
  - id: retrievePayout
    method: POST
    path: /ws/payout/retrieve
    summary: Retrieve Payout
  - id: searchPayouts
    method: POST
    path: /ws/payout/search
    summary: Search Payouts
  - id: simulatePayout
    method: POST
    path: /ws/payout/simulate
    summary: Simulate Payout
  - id: getPayoutBalance
    method: POST
    path: /ws/payout/balance
    summary: Get Payout Balance
  - id: verifyPayeeBankAccount
    method: POST
    path: /ws/payout/verify_account
    summary: Verify Payee Bank Account
  - id: createPayee
    method: POST
    path: /ws/payee/create
    summary: Create Payee
inputs:
  - name: integration_key
    secret: true
    required: true
  - name: external_uid
    required: true
  - name: country
    required: true
  - name: amount_target
    required: true
  - name: currency_target
    required: true
outputs:
  - payout_uid
  - status
  - fx_rate
  - estimated_settlement
governance:
  pii: true
  region: LATAM
  finCrimeRelevant: true