> For the complete documentation index, see [llms.txt](https://docs.rpay.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rpay.inc/developer-guides/api-reference/payout/implemention-guide.md).

# Implemention Guide

This page walks through the five usual ways to use Rocketfuel Payouts.

Full collection: [Rocketfuel Payouts (Postman)](https://payout-api.rpay.inc/)

## Scenario 1 — Onboard a payee

Add the person you want to pay, verify their identity, then move money from your payout account onto their balance.

#### 1. Invite the payee

**Postman:** [Payee Invite](https://payout-api.rpay.inc/#726eb772-637f-4b72-82f7-8d9e9bc293b1)

Send their name, country, email, and your own reference id (for example `VENDOR-1001`).

You get back a **payee id**. Save it.

If you see “Payee already registered”, look them up with [Payee List](https://payout-api.rpay.inc/#a44319a4-03a5-439d-9509-c21f4659541b) instead of inviting again.

#### 2. Submit KYC

**Postman:** [Payee KYC](https://payout-api.rpay.inc/#7f9cc61d-3f5f-4078-a318-26ff7f4beab1)

Use the payee id from step 1. For a person, send name, country, date of birth, and address. For a company, use the company option in the same Postman request.

KYC can take a little time. When it is **completed**, they can receive money. You can also check status with [Payee Detail](https://payout-api.rpay.inc/#9b4dfe91-6cff-47ec-bb29-4013c15e57fe).

#### 3. Put money on their balance

This is two steps: start the allocation, then confirm it. Make sure your merchant account has enough funds first (see Scenario 4).

**Start** — [Initiate Allocation](https://payout-api.rpay.inc/#bdf9fed7-d7b9-4a6a-a826-16aad4e7a41c)

Send the payee id, amount, currency (usually USD), and a short note such as “March payout”. Save the **allocation id**.

**Confirm** — [Confirm Allocation](https://payout-api.rpay.inc/#96af3945-5066-495c-9eec-8cd61293b6ee)

Use the allocation id and payee id. After this, the money is on the payee’s balance.

Changed your mind before confirming? Cancel it in Scenario 5.

#### 4. Check their balance

**Postman:** [Payee Balance](https://payout-api.rpay.inc/#44d4fc66-0f66-48d0-b8a2-e5921c6a6af8)

You should see the amount you just allocated. They are now ready for a bank or crypto payout.

**Also useful:** [Payee List](https://payout-api.rpay.inc/#a44319a4-03a5-439d-9509-c21f4659541b) · [Payee Detail](https://payout-api.rpay.inc/#9b4dfe91-6cff-47ec-bb29-4013c15e57fe) · [List Allocation](https://payout-api.rpay.inc/#bbd0869d-8af4-49d5-b6c8-77db1e0fe356)

***

## Scenario 2 — Pay to a bank and check status

Send money from the payee’s balance to their bank account, then check whether it arrived.

Finish Scenario 1 first. In Postman, put the **payee id** on every request in this flow.

#### 1. Make sure bank payouts are available

**Postman:** [Fiat Transfer Availability Check](https://payout-api.rpay.inc/#9815ebce-06c5-4cb8-98e8-e1abaaa69d6b)

If fiat is not enabled, email [**support@rpay.inc**](mailto:support@rpay.inc).

#### 2. Create their payout profile

**Postman:** [Create payout account](https://payout-api.rpay.inc/#19c83dde-46af-4408-a5ee-769ddd885167)

Send first name, last name, email, and country (three-letter code such as `USA`).

#### 3. Pick country, currency, and method

Open these in order and keep what Postman returns:

* [Fiat Supported Countries](https://payout-api.rpay.inc/#79422571-1850-4cdc-8be1-494694cefd25)
* [Fiat Supported Currencies](https://payout-api.rpay.inc/#84aaae43-f64b-46b5-83c9-eb47e97901e2)
* [Payment Methods](https://payout-api.rpay.inc/#6a9efde5-ffdd-49f2-a718-5296a66e30e3)
* [Payment options](https://payout-api.rpay.inc/#b672f73a-5f4e-4477-b196-ee0e22ddf66d) (wire, instant, next day, and similar)

#### 4. Save their bank details

Load the form first — fields change by country.

* [Fiat Transfer Bank Form](https://payout-api.rpay.inc/#acfd0232-2d2b-4833-b7de-b160ba128926)
* [Save Bank Details](https://payout-api.rpay.inc/#c1c35791-569b-473a-9e72-15a25ae6d503)

You get back an **account token**. That is the bank account you will pay into.

Later: [List Bank Details](https://payout-api.rpay.inc/#e0cee5fc-0c86-40f1-bb01-d0effdc6e6c0) · [Delete Bank Details](https://payout-api.rpay.inc/#c90e0f7c-e724-4214-b015-3682b7f3d343)

#### 5. Check the fee, then send

**Fee** — [Pre-Validate Fiat Transfer](https://payout-api.rpay.inc/#0f44197f-e799-46a4-a4a1-388652b83575)

This shows how much they will receive and gives you a **record id**. If you see an allocation error, they do not have money on their balance yet — go back to Scenario 1.

**Send** — [Fiat Transfer](https://payout-api.rpay.inc/#c04ba1d9-7f51-4f8a-8e34-8c148e6d7712)

Use the account token, amount, currency, and record id. You get back an **order id**. Status starts as pending.

#### 6. Check if it went through

**Postman:** [Transfer Status](https://payout-api.rpay.inc/#bcb1359c-b2e9-48d6-9a4d-9e43df9f7600)

Use the order id and payee id.

* **Pending (**`0`**)** — still processing; wait and check again
* **Success (**`1`**)** — money sent
* **Failed (**`-1`**)** — it did not go through; check the message or contact support

***

## Scenario 3 — Pay to crypto and check status

Send money from the payee’s balance to a crypto wallet, then check whether it arrived.

Finish Scenario 1 first. In Postman, put the **payee id** on the currency, fee, and transfer requests.

#### 1. See which coins you can pay in

**Postman:** [Payout Currencies](https://payout-api.rpay.inc/#58f93f20-6016-4952-bfcd-25679c691d01)

Pick a currency and network (for example USDC on Ethereum). Use those same names in the next steps.

#### 2. Check the wallet address

**Postman:** [Know your address](https://payout-api.rpay.inc/#b30b045d-c7ff-434c-9a1d-04f99cdc06fd)

You want **approved**. If it is not approved, do not send the payout.

#### 3. Check the fee, then double-check

* [Crypto Transfer Fee](https://payout-api.rpay.inc/#619a1172-612c-414e-a7ec-c110f10441a0) — what the transfer will cost
* [Pre-Validate Crypto Transfer](https://payout-api.rpay.inc/#a70d5c01-9914-4289-8c12-b15520cdf303) — confirms amount, wallet, and network

If you see “Payee is not eligible”, KYC is not finished or the payee is blocked.

#### 4. Send the transfer

**Postman:** [Crypto Transfer](https://payout-api.rpay.inc/#f9bf6a92-2387-4595-b558-cff3d7422a89)

Send the amount, coin, network, and wallet address. If the wallet is not the payee’s own, fill in the owner’s name in the Postman request.

You get back an **order id**. Status starts as pending.

#### 5. Check if it went through

**Postman:** [Transfer Status](https://payout-api.rpay.inc/#bcb1359c-b2e9-48d6-9a4d-9e43df9f7600)

Same as bank payouts: pending `0`, success `1`, failed `-1`. When it succeeds, you may also get a blockchain transaction hash.

***

## Scenario 4 — Check your balance

See how much you can pay out, and add more money if needed.

Do this before you allocate if you are not sure there is enough in the account.

#### 1. Check how much you can allocate

**Postman:** [Check Balance](https://payout-api.rpay.inc/#990ea9d2-3ee7-4d82-8a10-0a67a0ff594d)

* **Available balance** — money you can still put on payees
* **Current balance** — money sitting in your payout account
* **Allocated funds** — money already given to payees

#### 2. Check the live balance

**Postman:** [Check Running Balance](https://payout-api.rpay.inc/#fe7433b4-0db4-470b-a9f4-aade6c0711a1)

This includes allocations still in progress, so it can differ from available balance for a short time.

#### 3. Add funds

Ask Rocketfuel for your **wiring instructions** (the bank account you send money to). After the wire arrives, Check Balance should show a higher available amount. Then go back to Scenario 1 and allocate.

**Note:** You fund your merchant payout account once, then split that money across payees. You do not wire money to each payee directly.

#### 4. Check one payee’s balance

**Postman:** [Payee Balance](https://payout-api.rpay.inc/#44d4fc66-0f66-48d0-b8a2-e5921c6a6af8)

Use this after an allocation to confirm they received the funds.

***

## Scenario 5 — Take money back or pause a payee

Use this if you allocated too much, a job was cancelled, or you need to stop paying someone.

**Note:** You can only take back money that is still on the payee’s Rocketfuel balance. Once it has been sent to a bank or a crypto wallet, these steps will not reverse it. Blocking does **not** take their money back. Reclaim first if you also need the unused balance.

#### Cancel a pending allocation

If you have not confirmed the allocation yet:

**Postman:** [Cancel Allocation](https://payout-api.rpay.inc/#4f3096bc-5e29-4c98-b2b7-10f51787d667)

Use the allocation id and payee id. To find pending ones: [List Allocation](https://payout-api.rpay.inc/#bbd0869d-8af4-49d5-b6c8-77db1e0fe356)

#### Take unused money back

1. See how much you can take — [Reclaim balance](https://payout-api.rpay.inc/#55500a1d-b040-4ce9-ad3a-f4e2cd52aef3)
2. Take it back — [Reclaim Funds](https://payout-api.rpay.inc/#2876fead-6ce2-447e-a11e-13d521139747)

Send the payee id, the amount (not more than the reclaimable balance), and a short reason.

Then check [Payee Balance](https://payout-api.rpay.inc/#44d4fc66-0f66-48d0-b8a2-e5921c6a6af8) (should be lower) and [Check Balance](https://payout-api.rpay.inc/#990ea9d2-3ee7-4d82-8a10-0a67a0ff594d) (your account should be higher).

#### Pause or restore a payee

* **Block** — [Payee Block](https://payout-api.rpay.inc/#d2200702-7fe6-46b9-99a4-c1a46a82c41b) — they cannot receive more payouts
* **See who is blocked** — [List Blocked Payee](https://payout-api.rpay.inc/#9ef1353f-81de-48ae-9b15-0c4c20d66951)
* **Unblock** — [Payee Unblock](https://payout-api.rpay.inc/#39c9c79a-06ff-470d-b788-df8377dd53cc) — they can be paid again