Create Order

post

https://sandbox-api.transfi.com/v3/orders

Create a new order (onramp, offramp, payin, payout, prefund, swap).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

partnerId

string

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

userId

string

Required for onramp, offramp, payin, payout, swap, gaming

invoiceId

string

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

customerMetaData

object

Optional; This field can be used to pass additional customer metadata to the order.

purposeCode

string

required

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

purposeCodeReason

string

length ≥ 10

Optional. Required if purposeCode is 'other'. Must be at least 10 characters, using only letters, spaces, and basic punctuation.

sourceUrl

uri

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

successRedirectUrl

uri

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://qa-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

failureRedirectUrl

uri

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://qa-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

deviceDetails

object

Optional; This field can be used to pass device details of the user.

customization

object

Optional.

headlessMode

boolean

Defaults to false

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.

orderType

string

enum

required

source

object

required

destination

object

required

Headers

MID

string

required

Merchant or sub-merchant MID

Responses

200Order created successfully

400Validation error

500Internal server error