2901
New Payment
This works like a “virtual terminal” and will allow you to generate a payment in real time for a consumer who is present. This feature can be used from any web enabled device and is a fast, easy way to take a crypto payment.
Input Parameters
- Wallet – optional field to select the wallet the consumer will be sending their crypto from. This selection will help ensure the most appropriate QR for the wallet selected is displayed.
- Cryptocurrency – select the cryptocurrency the consumer will be paying with:
- BTC – Bitcoin
- BCH – Bitcoin Cash
- ETH – Ethereum
- LTC – Litecoin
- DASH – Dash Coin
- XRP – Ripple
- USDT - Tether (ERC-20)
- USDT- Tether (TRC-20)
- USDT- Tether (Polygon)
- USDC – Circle (ERC-20)
- USDC – Circle (Polygon)
- TRX - Tron
- MATIC - Matic
- FIAT – the fiat currency for this transaction:
- U.S. Dollar (USD)
- Euro (EUR)
- Great British Pounds (GBP)
- Hong Kong Dollar (HKD)
- Japanese Yen (JPY)
- Australian Dollar (AUD)
- Canadian Dollar (CAD)
- Swiss Franc (CHF)
- Danish Krone (DKK)
- Israeli New Shekel (ILS)
- Indian Rupee (INR)
- Norwegian Krone (NOK)
- Russian Ruble (RUB)
- Swedish Krona (SEK)
- Thai Bhat (THB)
- Bulgarian Lev (BGN)
- Mexican Peso (MXN)
- Amount – the amount, in fiat, you would like the consumer to pay.
Payment Options
- Accept Zero Confirmations – check this box if you would like the transaction to be approved immediately without having to wait for blockchain confirmation.
- Wait for KYT Before Confirmation – check this box if you would like to wait for the results of Chainalysis KYT before approving the transaction (recommended for very high value transactions).
Transactions
This is where you can view a report and search for all the payment that have been initiated for your account. There is also an export button on the top right of the report if you would like to download the report as a CSV file.
Filters
You can apply filters to assist you in generating reporting and finding payments that meet specific criteria.
- Currency – filter the results by a specific cryptocurrency
- Status – filter the results according to the status of the payment
- Confirmed – completed payment for which you will be settled
- Cancelled – incomplete transaction
- Pending – waiting on blockchain
- Refund – there is an amount to be either refunded or accepted
- Double Spending – crypto was double spent and not a valid payment
- Address – filter results by the receiving/ForumPay address for that payment
- Payment ID – filter results by the ForumPay Payment ID for that payment. This field will also work if you enter your reference number.
- Date From/Date To – filter results for a particular date range
Results
- Status – the status of that transaction.
- Confirmed – payment is completed and confirmed, funds will be settled to you
- Cancelled – payment has been cancelled, funds will not be settled to you
- Underpayment – less crypto was sent than invoiced, consumer can still remit additional crypto to complete the payment.
- Refund – you will see this button if there is an amount to be refunded.
- Open – this button will show the details of the payment. This is also where you can accept an underpayment or a late payment.
- Date – the date/time the payment was created
- Payment ID – the unique ForumPay Payment ID for a payment
- POS ID – the value you set for POS ID when you initiated the payment
- Reference No – the value you set for Reference No when you initiated the payment
- Invoice Amount – The fiat amount for the payment
- Payout Amount – The fiat amount that will be settled to you for the payment
- Amount – the amount of cryptocurrency for which the payment was initiated
- Payment Received – the amount of cryptocurrency the consumer sent
- Address – the unique blockchain address ForumPay created for this transaction. This is a clickable link that will take you to that address on the blockchain where you can view details.
- Payer IP Address – the IP address of the consumer when they made their payment
- Payer ID – your unique identifier associated to an individual consumer
Wallets
This is where you can manage the various cryptocurrency wallets you have in your ForumPay account. You have a wallet address for each cryptocurrency ForumPay has enabled.
- Currency – the cryptocurrency the wallet address is for
- Exchange Balance – the balance of that cryptocurrency still on ForumPay’s exchange
- My Address Balance – the balance of that cryptocurrency on your wallet address. You have complete control over this balance. In most instances, there will never be a balance as the crypto is being instantly converted to fiat. The address is a clickable link to see the address on the blockchain.
- Crypto Refunds – cryptocurrency balances that need to be refunded or accepted
Payouts
You can send payouts from the balance of any of the wallet addresses under My Address Balance.
- Mass Payouts – You can issue multiple payouts at once using the Mass Payouts button on the top of this page. Just upload a CSV file with a list of your payouts (using the format specified on this page). You can choose whether you would like to have the blockchain transaction fees for the payouts taken from the payout or cover those fees yourself.
- Individual Payouts – you can issue an individual payout by clicking the withdrawal button associated with any of your wallet addresses. Just enter the amount you want to send, the address you want to send it to and how you would like the fee allocated.
Widget
The widget page is where you can generate payment links, payment widgets and payment buttons for use with your business.
Payment Widget
The widget is our pre-made payment page intended to be used as an iFrame in your existing payment flow. To generate a payment widget the following parameters are used:
- Merchant ID (merchant_id) – this is your predefined merchant id and cannot be changed
- Order Amount (order_amount) – this is the amount, in Fiat, for the transaction
- Order Currency (order_currency) – the currency the Order Amount is in
- Item Name (item_name) – an optional field to enter the name of the item/service being paid for
- Widget Type (widget_type) – specify the type of widget you wish to use
- 0 – Standard widget
- 1 – Widget with mandatory fields for billing address
- 2 – Widget with mandatory fields for billing and shipping address in
- Reference No (reference_no) – an optional field to include a reference number to associate the transaction back to your internal platform/system
Payment Button
The payment button is intended to be placed on your website and link the user out to a hosted payment page on our website. To generate a payment button the following parameters are used:
- Merchant ID (merchant_id) – this is your predefined merchant id and cannot be changed
- Order Amount (order_amount) – this is the amount, in Fiat, for the transaction
- Order Currency (order_currency) – the currency the Order Amount is in
- Item Name (item_name) – an optional field to enter the name of the item/service being paid for
- Widget Type (widget_type) – specify the type of widget you wish to use
- 0 – Standard widget
- 1 – Widget with mandatory fields for billing address
- 2 – Widget with mandatory fields for billing and shipping address in
- Reference No (reference_no) – an optional field to include a reference number to associate the transaction back to your internal platform/system
Payment Link
This feature allows you to generate a payment link you can email or send for the recipient to make payment.
The input fields for this option are the same as the Widget or the Payment Button. Once applied you can simply copy the link and send it off for payment.
Account Management
This sub-menu will allow you to view and manage the details and settings for your ForumPay merchant account.
My Profile
The basic account settings can be found on this page
- Time zone for your account
- Security settings
- Time out length
- IP settings
- Password
- 2-Factor Autentication
Account Settings
Settings specific to your business’s merchant account
- Account Details - including your banking information for settlement (cannot be edited, to update banking info please email [email protected])
- Payment Settings
- Email Notification Settings
- User Access – control who else can access the account and what permissions they will have
- Fee Rate
Settlement
Here is where you can find all the details for the settlements ForumPay has made to you. You will also be able to see refunds you have processed.
The left navigation column will let you choose which settlement you want to look at or allow you to see any open transactions that have yet to be settled.
To view the individual payments included in a settlement you can click on the Open Report button. This report can then be downloaded as a CSV file.
If there were any refunds due during the settlement period, a separate section will show up for them. If the total is highlighted in yellow, it means there are refunds to still be sent out. If the total is highlighted in green, it means all refunds were processed.
API, Webhooks, Widget
Payment Gateway API Keys
This is where you can manage your API keys for access to the API. API keys have the following optional security settings that you can add to them:
- Can Perform Refunds – API key will be able to access RefundPayment API call to create and confirm crypto refunds.
- Can Transfer Crypto on Buy Orders – API key will be able to generate buy orders from the account’s fiat balance for crypto payouts/withdrawals.
- Can Perform Payouts – API key will be able to send payouts from the account’s crypto wallets
You can also revoke and remove any of the existing API keys. However, once created an API key cannot be edited.
The API User will be fully visible when looking at an API key. The API secret is always broken into two parts for security purposes. The first half is visible here, the second half is emailed to you upon creation.
Webhook Notifications
ForumPay uses webhook notifications, also referred to as Instant Payment Notifications (IPNs) to alert your integration whenever there is a change of state with a payment.
This section is where you can enter the address you wish our IPNs to be sent to.
There is also a link to a log where you can see all IPNs that have been sent to you.
