Create Payment Request

post https://api.thirdfi.org/api/v1/payment

Create payment request for on-ramp transaction

Body Params

Create payment request body

network

string

required

CryptoCurrency network that you would allow your customers to buy/sell. You can get the network name from GET /crypto-currencies. Example: 'mainnet', 'ethereum', 'bep2', 'matic'

walletAddress

string

required

The blockchain address of the user's wallet that the purchased cryptocurrency will be sent to.

emailAddress

string

required

ThirdFi user email address

trxType

string

required

Transaction Types, 'Buy', 'Sell'

fiatCurrency

string

required

The code of the fiat currency you want the customer to buy/sell cryptocurrency. You can get the symbol from GET /fiat-currencies. Example: 'INR', 'EUR', 'USD'.

fiatAmount

number

An integer amount representing how much the customer wants to spend/receive. Users can't change the fiat amount if this is passed. This parameter will be skipped if fiatCurrency is not passed.

cryptoCurrency

string

required

Crypto currency symbol that you would allow your customers to buy/sell. You can get the symbol from GET /crypto-currencies. Example: 'ETH', 'BTC', 'DAI'.

redirectURL

string

Redirect back to this URL, once the customer has completed their purchase/sell process.

cryptoAmount

number

An integer amount representing how much crypto the customer wants to sell. Users cannot change the crypto amount if this is passed.

isDisableCrypto

boolean

When true, then the customer will not see anything about the cryptocurrency. This will hide all the information related to crypto completely. This parameter will be ignored if cryptoCurrencyCode, walletAddress is not passed. This parameter is helpful if you are creating an app for the users who do not know much about the cryptocurrencies.

cancellationUrl

string

Redirect back to this URL, once the customer has cancelled their purchase/sell process.

paymentMethod

string

required

Payment method. You can get the payment method id from GET /fiat-currencies. Example: 'upi', 'credit_debit_card', 'gbp_bank_transfer'

Responses

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.thirdfi.org/api/v1/payment \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"trxType":"Buy"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment request is created

400Bad Request

401Unauthorized

403Forbidden Resources