Create Payout

post

https://sandbox-api.transfi.com/v2/payout/orders

Payouts in fiat currencies can be created for end users. These can be processed by prefunding TransFi in advance or using the payin balance (unsettled), depending on the preconfigured settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload passed in - Payouts POST Request

amount

integer

required

Order Amount

balanceCurrency

string

Specifies the fiat/stable currency from which you want the balance to be deducted. If balanceCurrency is not provided:

If quoteId is passed, the system uses your default balance currency (USDC, EUR)
If quoteId is not passed, it defaults to the local withdrawal currency

string

required

Email address

Unique Field

currency

string

required

Currency of Order
Example: IDR

depositDetails

object

Require to execute the payout agains the crypto deposit at transaction level.

additionalDetails

object

required

The field will be Dynamic with respect to country, currency and paymentCode passed.
Details of what field needs to be passed will be provided from the List Payment Methods API in Configuration

paymentCode

string

required

Name of the Payment Method
Example: dana

deviceDetails

object

required

Details of the user's device.

partnerContext

object

partnerId

string

Unique identifier for the order

purposeCode

string

enum

required

Purpose of the Payment

quoteId

string

Quote Id

Optional Field

Can be passed as a parameter while creating orders to ensure same quotes within one minute
After one minute the quoteId will expire and will have to be re-issued if passed in order payload.

Note: Offramp does not support Quote Caching functionality

Hit the exchange rates api for new quoteId

sourceUrl

string

Merchant website URL from where the traffic is flowing to TransFi.

Headers

MID

string

Merchant or sub-merchant MID. Used to execute the request in the context of that specific entity.

Responses

Unique Field

Optional Field

200off-Ramp / Fiat Payout Order Created

400Request containing missing or invalid parameters.

403Restrcited or Forbidden Access

404No resource found