Create Payin

post

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

Payments in fiat currencies can be accepted from end users. These payments can be settled either in a batch or instantly, depending on the preconfigured settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload passed in - Collections POST Request

amount

number

required

≥ 1

Order value

country

string

required

Country of Residence
Example: PH

balanceCurrency

string

Balance Currency

Optional Field

Specifies the fiat/stable currency for which you want to update balance in. If no value is specified, it will take your default balance currency(USDC, EUR)

currency

string

required

Currency of order
Example: PHP

string

required

Email address

Unique Field

firstName

string

required

First Name

lastName

string

required

Last Name

paymentType

string

enum

required

Type of payment

Allowed:

purposeCode

string

enum

required

Purpose of the Payment

redirectUrl

string

required

Url to be Redirected to

sourceUrl

string

required

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

additionalDetails

object

Required for the headless integration, and all fields to be submitted based on the response from v2/paymentMethods API.

deviceDetails

object

Details of the user's device. Required in headlessMode

headlessMode

enum

Only required for headless integration

Allowed:

partnerContext

object

partnerId

string

Unique Identifier for the Order

paymentCode

string

Name of the Payment Method
Example: bpi

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: Onramp does not support Quote Caching functionality

Hit the exchange rates api for new quoteId

withdrawDetails

object

User's bank details or crypto wallet address for the settlement. The settlement type is Batch by default. Please contact TransFi team to enable Instant settlement.

Headers

MID

string

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

Responses

Optional Field

Unique Field

Optional Field

200Fiat / on-Ramp Payin Information.

400Request containing missing or invalid parameters.

403Restrcited or Forbidden Access

404No resource found.