Skip to main content

Hosted Fiat Payout Session

Overview​

A Hosted Payout Session provides an end-to-end checkout flow where customers convert cryptocurrency to fiat through a hosted interface. This solution includes KYC verification, payment method selection, and transaction monitoring through Webhooks.

The session is a simple and secure, hosted end-to-end flow allowing your customers to offramp to your application. It includes access to the Business Dashboard, providing an overview of all your accounts, transactions, and customers, as well as the ability to download reports and manage integration settings.

Example Scenario​

Imagine a remittance company enabling customers to send money home by converting their crypto holdings. The company initiates a session with the recipient's details and amount, receives a HostedURL for the secure checkout flow, and gets Webhook notifications when funds are successfully sent to the recipient's local bank account.

Recipe​

Implement a scenario as described above by following the steps below.

Hosted Checkout Step Diagram

1. Initiate a Hosted Checkout Session

Submit a POST request to start a Hosted Checkout session. In your request, include your API Key in the header along with the transaction details and the customer's KYC data. View the POST checkout/payout/fiat endpoint for detailed instructions on initiating a session. The response will provide you with a HostedURL and a CheckoutPaymentID.

2. Handle the API Response

Store the HostedURL and CheckoutPaymentID received. These are essential for validating transaction completion and monitoring your customer's activity.

3. Direct the Customer to Payment

Redirect your customer to the HostedURL to carry out the transaction on NOAH's secure checkout page.

4. Transaction Status Updates via Webhooks

Set up to receive notifications through webhooks about the status of the transaction. These will inform you of successful transactions through a Successful Transaction Webhook and of any failures via a Failed Transaction Webhook. For more details, view Transactions Webhooks.

5. Post-Transaction Account Management

Following a successful transaction, adjust your customer’s account balance accordingly, reflecting the items described in the LineItems field exactly. All transaction attempts, successful or otherwise, are recorded in your NOAH Business Dashboard for tracking and analysis.