> For the complete documentation index, see [llms.txt](https://docs.fonbnk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fonbnk.com/countries/nigeria/bank-transfer.md).

# Bank transfer

How to on-ramp and off-ramp NGN with bank transfer in Nigeria: fields, limits and API examples.

| countryIsoCode | currencyIsoCode | paymentChannel | Typical settlement          |
| -------------- | --------------- | -------------- | --------------------------- |
| `NG`           | `NGN`           | `bank`         | Minutes after the user pays |

{% hint style="warning" %}
The walkthroughs ran in sandbox on 2026-10-09. The limits, fields and KYC rules are a snapshot of production on 2026-10-09. They change when providers change, so build against [Get available currencies](https://docs.fonbnk.com/server-to-server/api-endpoints/get-available-currencies.md) and the `fieldsToCreateOrder` of each quote, not against this page.
{% endhint %}

| Route                   | Per order (production) | Transfer type |
| ----------------------- | ---------------------- | ------------- |
| On-ramp, Bank transfer  | 1,408 to 704,082 NGN   | `manual`      |
| Off-ramp, Bank transfer | 5,000 to 657,618 NGN   | —             |

Before the first call: set up the keys and the signing helpers from [Countries](https://docs.fonbnk.com/countries.md), and verify the user as [Nigeria](https://docs.fonbnk.com/countries/nigeria.md) explains.

## Quirks

{% hint style="info" %}
The bank on-ramp is a `manual` transfer. The user pays into the account in `transferInstructions` and must put the **transfer narration** in the payment reference. A payment without the narration, or from another account than the one the user gave, is not matched.
{% endhint %}

{% hint style="info" %}
Bank codes are different for each provider that routes the order. Take `bankCode` from the `options` of the quote you are using, and do not keep a bank list of your own.
{% endhint %}

## On-ramp

### 1. Get a quote

The quote fixes the rate and lists the fields to collect from the user. Use it before `quoteExpiresAt`, or get a new one.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/quote'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"deposit":{"paymentChannel":"bank","currencyType":"fiat","currencyCode":"NGN","countryIsoCode":"NG","amount":6000},"payout":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"}}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/quote', {
  "deposit": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "countryIsoCode": "NG",
    "amount": 6000
  },
  "payout": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT"
  }
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, fee amounts and long lists cut)" overflow="wrap" expandable="true" %}

```json
{
  "quoteId": "665000000000000000000004",
  "quoteExpiresAt": "2026-10-09T12:30:00.000Z",
  "deposit": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "currencyDetails": {
      "countryIsoCode": "NG"
    },
    "cashout": {
      "amountBeforeFees": 6000,
      "amountAfterFees": 5850,
      "amountBeforeFeesUsd": 4.347007,
      "amountAfterFeesUsd": 4.238332,
      "exchangeRate": 1380.26,
      "exchangeRateAfterFees": 1415.6513,
      "feeSettings": [
        {
          "id": "service_fee",
          "type": "percentage",
          "recipient": "platform"
        }
      ]
    },
    "fieldsToCreateOrder": [
      {
        "key": "phoneNumber",
        "label": "Phone Number",
        "required": true,
        "type": "phone"
      },
      {
        "key": "bankCode",
        "label": "Bank name",
        "required": true,
        "type": "enum",
        "options": [
          {
            "label": "Sandbox Bank",
            "value": "1"
          },
          {
            "label": "Sandbox Bank 2",
            "value": "2"
          },
          {
            "label": "Sandbox Bank 3",
            "value": "3"
          }
        ]
      },
      {
        "key": "bankAccountNumber",
        "label": "Bank Account Number",
        "required": true,
        "type": "string"
      },
      {
        "key": "depositSandboxForcedFlow",
        "type": "enum",
        "label": "Sandbox deposit forced flow",
        "required": false,
        "defaultValue": "deposit_success",
        "options": [
          {
            "label": "Deposit success",
            "value": "deposit_success"
          },
          {
            "label": "Deposit invalid",
            "value": "deposit_invalid"
          },
          {
            "label": "Deposit underpayment (50%)",
            "value": "deposit_underpayment"
          }
        ]
      }
    ],
    "transferType": "manual"
  },
  "payout": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT",
    "currencyDetails": {
      "network": "CELO",
      "asset": "USDT",
      "contractAddress": "0xd5cf8ab08295e32db2e2dce8478e5ce021340a57"
    },
    "cashout": {
      "amountBeforeFees": 4.238332,
      "amountAfterFees": 4.238332,
      "amountBeforeFeesUsd": 4.238332,
      "amountAfterFeesUsd": 4.238332,
      "exchangeRate": 1,
      "exchangeRateAfterFees": 1,
      "feeSettings": []
    },
    "fieldsToCreateOrder": [
      {
        "key": "blockchainWalletAddress",
        "type": "string",
        "label": "Your wallet address",
        "required": true
      },
      {
        "key": "blockchainMemo",
        "type": "string",
        "label": "Memo",
        "required": false
      },
      {
        "key": "payoutSandboxForcedFlow",
        "type": "enum",
        "label": "Sandbox payout forced flow",
        "required": false,
        "defaultValue": "payout_success",
        "options": [
          {
            "label": "Payout success",
            "value": "payout_success"
          },
          {
            "label": "Payout failed",
            "value": "payout_failed"
          }
        ]
      }
    ]
  }
}
```

{% endcode %}

In production the quote asks for these fields:

| Field                     | Label               | Type     | Required | Example                                                 |
| ------------------------- | ------------------- | -------- | -------- | ------------------------------------------------------- |
| `phoneNumber`             | Phone Number        | `phone`  | Yes      | `2348012345678`                                         |
| `bankCode`                | Bank name           | `enum`   | Yes      | One of 286 `options` in the quote, for example `999992` |
| `bankAccountNumber`       | Bank Account Number | `string` | Yes      | `0123456789`                                            |
| `blockchainWalletAddress` | Your wallet address | `string` | Yes      | `0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20`            |
| `blockchainMemo`          | Memo                | `string` | No       | —                                                       |

Sandbox asks for the same fields. Its enum options, such as bank codes, are sandbox fixtures.

### 2. Create the order

Send `quoteId` from the quote, and every required field of both legs as one flat `fieldsToCreateOrder` object.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"quoteId":"665000000000000000000004","userEmail":"user@example.com","userIp":"102.89.23.10","userCountryIsoCode":"NG","deposit":{"paymentChannel":"bank","currencyType":"fiat","currencyCode":"NGN","countryIsoCode":"NG","amount":6000},"payout":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"},"fieldsToCreateOrder":{"phoneNumber":"2348012345678","bankCode":"1","bankAccountNumber":"0123456789","blockchainWalletAddress":"0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20"},"orderParams":"my-order-onramp-bank"}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/order', {
  "quoteId": "665000000000000000000004",
  "userEmail": "user@example.com",
  "userIp": "102.89.23.10",
  "userCountryIsoCode": "NG",
  "deposit": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "countryIsoCode": "NG",
    "amount": 6000
  },
  "payout": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT"
  },
  "fieldsToCreateOrder": {
    "phoneNumber": "2348012345678",
    "bankCode": "1",
    "bankAccountNumber": "0123456789",
    "blockchainWalletAddress": "0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20"
  },
  "orderParams": "my-order-onramp-bank"
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, order fields cut)" overflow="wrap" expandable="true" %}

```json
{
  "quoteUsed": true,
  "order": {
    "_id": "665000000000000000000005",
    "status": "deposit_awaiting",
    "expiresAt": "2026-10-09T12:05:00.000Z",
    "deposit": {
      "paymentChannel": "bank",
      "currencyType": "fiat",
      "currencyCode": "NGN",
      "currencyDetails": {
        "countryIsoCode": "NG"
      },
      "cashout": {
        "exchangeRate": 1380.26,
        "feeSettings": [
          {
            "id": "service_fee",
            "type": "percentage",
            "recipient": "platform"
          }
        ],
        "exchangeRateAfterFees": 1415.6513,
        "amountBeforeFees": 6000,
        "amountAfterFees": 5850,
        "amountBeforeFeesUsd": 4.347007,
        "amountAfterFeesUsd": 4.238332
      },
      "providedFieldsToCreateOrder": {
        "phoneNumber": "2348012345678",
        "bankCode": "1",
        "bankAccountNumber": "0123456789"
      },
      "transferInstructions": {
        "type": "manual",
        "instructionsText": "It is a sandbox offer. Confirm the transfer from your side and system will automatically confirm the transfer within 1 minute.",
        "warningText": "Non-confirmed orders will be automatically canceled after 5 minutes.",
        "transferDetails": [
          {
            "id": "recipientBankName",
            "label": "Bank name",
            "value": "Sandbox Bank"
          },
          {
            "id": "recipientBankAccountNumber",
            "label": "Bank account number",
            "value": "5119446927"
          },
          {
            "id": "recipientBankAccountName",
            "label": "Bank account name",
            "value": "SANDY BOXERRITTO"
          },
          {
            "id": "amountToSend",
            "label": "Amount to send",
            "value": "6000"
          }
        ],
        "fieldsToConfirmOrder": []
      },
      "formattedUserFieldsToCreateOrder": [
        {
          "key": "phoneNumber",
          "label": "Phone Number",
          "value": "2348012345678",
          "type": "phone"
        },
        {
          "key": "bankCode",
          "label": "Bank name",
          "value": "Sandbox Bank",
          "type": "enum"
        },
        {
          "key": "bankAccountNumber",
          "label": "Bank Account Number",
          "value": "0123456789",
          "type": "string"
        },
        {
          "key": "depositSandboxForcedFlow",
          "label": "Sandbox deposit forced flow",
          "value": null,
          "type": "enum"
        }
      ]
    }
  }
}
```

{% endcode %}

### 3. Take the payment

The transfer type is `manual`. Show the user `order.deposit.transferInstructions`. The user pays to the account in `transferDetails`. When the user says they paid, call [Confirm order](https://docs.fonbnk.com/server-to-server/api-endpoints/confirm-order.md) with the fields in `transferInstructions.fieldsToConfirmOrder`.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order/confirm'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"orderId":"665000000000000000000005","fieldsToConfirmOrder":{}}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/order/confirm', {
  "orderId": "665000000000000000000005",
  "fieldsToConfirmOrder": {}
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, status fields only)" overflow="wrap" %}

```json
{
  "_id": "665000000000000000000005",
  "status": "deposit_validating"
}
```

{% endcode %}

### 4. Wait for the final status

The [webhook](https://docs.fonbnk.com/server-to-server/webhooks.md) tells you each new status. To check an order, call [Get order](https://docs.fonbnk.com/server-to-server/api-endpoints/get-order.md). What to do at each status is on [Countries](https://docs.fonbnk.com/countries.md). In sandbox this order reached `payout_successful`.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order?orderId=665000000000000000000005'
TIMESTAMP=$(($(date +%s) * 1000))
curl "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")"
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('GET', '/api/v2/order?orderId=665000000000000000000005');
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, status fields only)" overflow="wrap" %}

```json
{
  "_id": "665000000000000000000005",
  "status": "payout_successful",
  "statusChangeLogs": [
    {
      "oldStatus": "deposit_awaiting",
      "newStatus": "deposit_validating",
      "date": "2026-10-09T12:00:00.000Z"
    },
    {
      "oldStatus": "deposit_validating",
      "newStatus": "deposit_successful",
      "date": "2026-10-09T12:01:00.000Z"
    },
    {
      "oldStatus": "deposit_successful",
      "newStatus": "payout_pending",
      "date": "2026-10-09T12:01:00.000Z"
    },
    {
      "oldStatus": "payout_pending",
      "newStatus": "payout_successful",
      "date": "2026-10-09T12:01:00.000Z"
    }
  ]
}
```

{% endcode %}

## Off-ramp

### 1. Get a quote

The quote fixes the rate and lists the fields to collect from the user. Use it before `quoteExpiresAt`, or get a new one.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/quote'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"deposit":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"},"payout":{"paymentChannel":"bank","currencyType":"fiat","currencyCode":"NGN","countryIsoCode":"NG","amount":20000}}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/quote', {
  "deposit": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT"
  },
  "payout": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "countryIsoCode": "NG",
    "amount": 20000
  }
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, fee amounts and long lists cut)" overflow="wrap" expandable="true" %}

```json
{
  "quoteId": "665000000000000000000007",
  "quoteExpiresAt": "2026-10-09T12:31:00.000Z",
  "deposit": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT",
    "currencyDetails": {
      "network": "CELO",
      "asset": "USDT",
      "contractAddress": "0xd5cf8ab08295e32db2e2dce8478e5ce021340a57"
    },
    "cashout": {
      "amountBeforeFees": 15.135841,
      "amountAfterFees": 15.135841,
      "amountBeforeFeesUsd": 15.135841,
      "amountAfterFeesUsd": 15.135841,
      "exchangeRate": 1,
      "exchangeRateAfterFees": 1,
      "feeSettings": []
    },
    "fieldsToCreateOrder": [
      {
        "key": "blockchainWalletAddress",
        "type": "string",
        "label": "Your wallet address",
        "required": false
      },
      {
        "key": "depositSandboxForcedFlow",
        "type": "enum",
        "label": "Sandbox deposit forced flow",
        "required": false,
        "defaultValue": "deposit_success",
        "options": [
          {
            "label": "Deposit success",
            "value": "deposit_success"
          },
          {
            "label": "Deposit invalid",
            "value": "deposit_invalid"
          },
          {
            "label": "Deposit invalid: transfer not found",
            "value": "deposit_crypto_transfer_not_found"
          }
        ]
      }
    ],
    "transferType": "manual"
  },
  "payout": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "currencyDetails": {
      "countryIsoCode": "NG"
    },
    "cashout": {
      "amountBeforeFees": 20513,
      "amountAfterFees": 20000,
      "amountBeforeFeesUsd": 15.135841,
      "amountAfterFeesUsd": 14.757316,
      "exchangeRate": 1355.26,
      "exchangeRateAfterFees": 1390.0224,
      "feeSettings": [
        {
          "id": "service_fee",
          "type": "percentage",
          "recipient": "platform"
        }
      ]
    },
    "fieldsToCreateOrder": [
      {
        "key": "phoneNumber",
        "label": "Phone Number",
        "required": true,
        "type": "phone"
      },
      {
        "key": "bankCode",
        "label": "Bank name",
        "required": true,
        "type": "enum",
        "options": [
          {
            "label": "Sandbox Bank",
            "value": "1"
          },
          {
            "label": "Sandbox Bank 2",
            "value": "2"
          },
          {
            "label": "Sandbox Bank 3",
            "value": "3"
          }
        ]
      },
      {
        "key": "bankAccountNumber",
        "label": "Bank Account Number",
        "required": true,
        "type": "string"
      },
      {
        "key": "payoutSandboxForcedFlow",
        "type": "enum",
        "label": "Sandbox payout forced flow",
        "required": false,
        "defaultValue": "payout_success",
        "options": [
          {
            "label": "Payout success",
            "value": "payout_success"
          },
          {
            "label": "Payout failed",
            "value": "payout_failed"
          }
        ]
      }
    ]
  }
}
```

{% endcode %}

In production the quote asks for these fields:

| Field                     | Label               | Type     | Required | Example                                                 |
| ------------------------- | ------------------- | -------- | -------- | ------------------------------------------------------- |
| `blockchainWalletAddress` | Your wallet address | `string` | No       | `0x5b7ae3c6c87f4a3f94b35c77233b13191ebfad20`            |
| `phoneNumber`             | Phone Number        | `phone`  | Yes      | `2348012345678`                                         |
| `bankCode`                | Bank name           | `enum`   | Yes      | One of 286 `options` in the quote, for example `999992` |
| `bankAccountNumber`       | Bank Account Number | `string` | Yes      | `0123456789`                                            |

Sandbox asks for the same fields. Its enum options, such as bank codes, are sandbox fixtures.

### 2. Create the order

Send `quoteId` from the quote, and every required field of both legs as one flat `fieldsToCreateOrder` object.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"quoteId":"665000000000000000000007","userEmail":"user@example.com","userIp":"102.89.23.10","userCountryIsoCode":"NG","deposit":{"paymentChannel":"crypto","currencyType":"crypto","currencyCode":"CELO_USDT"},"payout":{"paymentChannel":"bank","currencyType":"fiat","currencyCode":"NGN","countryIsoCode":"NG","amount":20000},"fieldsToCreateOrder":{"phoneNumber":"2348012345678","bankCode":"1","bankAccountNumber":"0123456789"},"orderParams":"my-order-offramp-bank"}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/order', {
  "quoteId": "665000000000000000000007",
  "userEmail": "user@example.com",
  "userIp": "102.89.23.10",
  "userCountryIsoCode": "NG",
  "deposit": {
    "paymentChannel": "crypto",
    "currencyType": "crypto",
    "currencyCode": "CELO_USDT"
  },
  "payout": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "countryIsoCode": "NG",
    "amount": 20000
  },
  "fieldsToCreateOrder": {
    "phoneNumber": "2348012345678",
    "bankCode": "1",
    "bankAccountNumber": "0123456789"
  },
  "orderParams": "my-order-offramp-bank"
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, order fields cut)" overflow="wrap" expandable="true" %}

```json
{
  "quoteUsed": true,
  "order": {
    "_id": "665000000000000000000008",
    "status": "deposit_awaiting",
    "expiresAt": "2026-10-09T12:31:00.000Z",
    "deposit": {
      "paymentChannel": "crypto",
      "currencyType": "crypto",
      "currencyCode": "CELO_USDT",
      "currencyDetails": {
        "network": "CELO",
        "asset": "USDT",
        "contractAddress": "0xd5cf8ab08295e32db2e2dce8478e5ce021340a57"
      },
      "cashout": {
        "exchangeRate": 1,
        "feeSettings": [],
        "exchangeRateAfterFees": 1,
        "amountBeforeFees": 15.135841,
        "amountAfterFees": 15.135841,
        "amountBeforeFeesUsd": 15.135841,
        "amountAfterFeesUsd": 15.135841
      },
      "providedFieldsToCreateOrder": {},
      "transferInstructions": {
        "type": "manual",
        "instructionsText": "Please send the exact amount of crypto to the address below. Make sure to send only USDT on the Celo network. Sending any other assets or using a different network may result in loss of funds.",
        "transferDetails": [
          {
            "id": "recipientWalletAddress",
            "label": "Wallet address to send",
            "value": "<the deposit address of your order>"
          },
          {
            "id": "senderWalletAddress",
            "label": "Your wallet address"
          },
          {
            "id": "amountToSend",
            "label": "Amount to send",
            "value": "15.135841"
          },
          {
            "id": "cryptoTransactionRequestAdditionalData",
            "label": "Crypto transaction additional data",
            "value": ""
          }
        ],
        "fieldsToConfirmOrder": [
          {
            "key": "blockchainTransactionHash",
            "type": "string",
            "label": "Transaction hash",
            "required": true
          }
        ]
      },
      "formattedUserFieldsToCreateOrder": [
        {
          "key": "blockchainWalletAddress",
          "label": "Your wallet address",
          "value": null,
          "type": "string"
        },
        {
          "key": "depositSandboxForcedFlow",
          "label": "Sandbox deposit forced flow",
          "value": null,
          "type": "enum"
        }
      ]
    }
  }
}
```

{% endcode %}

### 3. Receive the crypto

The user sends the crypto to the address in `order.deposit.transferInstructions`. Then call [Confirm order](https://docs.fonbnk.com/server-to-server/api-endpoints/confirm-order.md) with the fields in `transferInstructions.fieldsToConfirmOrder`, here the `blockchainTransactionHash` of that transfer. We check the transfer on-chain, and the payout starts when it is confirmed.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order/confirm'
TIMESTAMP=$(($(date +%s) * 1000))
curl -X POST "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")" \
  -H "Content-Type: application/json" \
  --data '{"orderId":"665000000000000000000008","fieldsToConfirmOrder":{"blockchainTransactionHash":"0x227777e5fbfc759d65bf1b5d959e698a0a64181d7eeabf298590fd9eec072ab2"}}'
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('POST', '/api/v2/order/confirm', {
  "orderId": "665000000000000000000008",
  "fieldsToConfirmOrder": {
    "blockchainTransactionHash": "0x227777e5fbfc759d65bf1b5d959e698a0a64181d7eeabf298590fd9eec072ab2"
  }
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, status fields only)" overflow="wrap" %}

```json
{
  "_id": "665000000000000000000008",
  "status": "deposit_validating"
}
```

{% endcode %}

### 4. Wait for the final status

The [webhook](https://docs.fonbnk.com/server-to-server/webhooks.md) tells you each new status. To check an order, call [Get order](https://docs.fonbnk.com/server-to-server/api-endpoints/get-order.md). What to do at each status is on [Countries](https://docs.fonbnk.com/countries.md). Sandbox crypto runs on a test network and checks each deposit on-chain. The sample hash above matches no transfer, so this sandbox order stays in `deposit_validating`. Send a real test-network transfer to finish an off-ramp in sandbox.

{% tabs %}
{% tab title="curl" %}
{% code overflow="wrap" %}

```bash
ENDPOINT='/api/v2/order?orderId=665000000000000000000008'
TIMESTAMP=$(($(date +%s) * 1000))
curl "$FONBNK_BASE_URL$ENDPOINT" \
  -H "x-client-id: $FONBNK_CLIENT_ID" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-signature: $(fonbnk_sign "$TIMESTAMP" "$ENDPOINT")"
```

{% endcode %}
{% endtab %}

{% tab title="TypeScript" %}
{% code overflow="wrap" %}

```typescript
const response = await fonbnkRequest('GET', '/api/v2/order?orderId=665000000000000000000008');
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% code title="Response (sandbox, status fields only)" overflow="wrap" %}

```json
{
  "_id": "665000000000000000000008",
  "status": "deposit_validating",
  "statusChangeLogs": [
    {
      "oldStatus": "deposit_awaiting",
      "newStatus": "deposit_validating",
      "date": "2026-10-09T12:01:00.000Z"
    }
  ]
}
```

{% endcode %}

## Testing in sandbox

Add one of these fields to `fieldsToCreateOrder` to force how a sandbox order ends, then run the walkthrough. Without them, a sandbox on-ramp succeeds. No real money moves.

| Route                   | Field                      | Values                                                                                                                                                                              |
| ----------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| On-ramp, Bank transfer  | `depositSandboxForcedFlow` | `deposit_success`, `deposit_invalid`, `deposit_underpayment`, `deposit_overpayment`, `deposit_payment_info_mismatch`                                                                |
| On-ramp, Bank transfer  | `payoutSandboxForcedFlow`  | `payout_success`, `payout_failed`                                                                                                                                                   |
| Off-ramp, Bank transfer | `depositSandboxForcedFlow` | `deposit_success`, `deposit_invalid`, `deposit_crypto_transfer_not_found`, `deposit_crypto_sender_mismatch`, `deposit_crypto_transfer_reverted`, `deposit_crypto_paid_before_order` |
| Off-ramp, Bank transfer | `payoutSandboxForcedFlow`  | `payout_success`, `payout_failed`                                                                                                                                                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.fonbnk.com/countries/nigeria/bank-transfer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
