Create Order

Optional; This field can be used to reference your own transaction Id with TransFi's order Id.

Required for onramp, offramp, payin, payout, swap, gaming. For onramp and offramp, this field must be omitted when using the user-user (third-party) flow — in that case, provide source.userId and destination.userId instead.

Can be obtained from the /v3/invoices/create endpoint. Relevant for payin and payout orderTypes.

Optional. Only applicable for orderType payin and gaming. This is the account where you want your funds to be paid out. The settlementAccountId's currency should match with the destination.currency passed.

Purpose of the Payment. Enum values for purposeCode can be found here.

Merchant website URL from where the traffic is flowing to TransFi. Must include https:// protocol.

URL to redirect the user after a successful transfer. Must include the https:// protocol. This field is not required if a default redirectUrl is configured in the Displ-AI dashboard [https://displai.transfi.com/settings/integration]. Providing a value in this field will override the default redirectUrl configured in the dashboard. If a redirectUrl is not configured in the dashboard, this field is required for: - Gaming orders - Cases where headlessMode is false and the orderType is one of: onramp, offramp, payin, swap

URL to redirect the user after a failed transfer. Must include the https:// protocol. This field is not required if a default redirectUrl is configured in the Displ-AI dashboard [https://displai.transfi.com/settings/integration]. Providing a value in this field will override the default redirectUrl configured in the dashboard. If a redirectUrl is not configured in the dashboard, this field is required for: - Gaming orders - Cases where headlessMode is false and the orderType is one of: onramp, offramp, payin, swap

Optional; defaults to false. When true, enables headless mode for the payment flow: the user is not redirected to a payment page. All required additional payment details for the source object must be provided in this API payload. NOte: This field is relevant for payin, swap, onramp, offramp orderTypes.