Skip to main content
POST
/
v1
/
deposits
Create deposit
curl --request POST \
  --url https://api.example.com/v1/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100.50",
  "clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
  "currency": "EUR",
  "country": "GB",
  "description": "Account top-up",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "method": "open_banking",
  "phoneNumber": "+2348012345678",
  "referenceId": "INV-2024-001"
}
'
import requests

url = "https://api.example.com/v1/deposits"

payload = {
    "amount": "100.50",
    "clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
    "currency": "EUR",
    "country": "GB",
    "description": "Account top-up",
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "method": "open_banking",
    "phoneNumber": "+2348012345678",
    "referenceId": "INV-2024-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '100.50',
    clientRef: '609eddec-9b97-4f41-8db3-ef9342263418',
    currency: 'EUR',
    country: 'GB',
    description: 'Account top-up',
    email: 'john.doe@example.com',
    firstName: 'John',
    lastName: 'Doe',
    method: 'open_banking',
    phoneNumber: '+2348012345678',
    referenceId: 'INV-2024-001'
  })
};

fetch('https://api.example.com/v1/deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '100.50',
    'clientRef' => '609eddec-9b97-4f41-8db3-ef9342263418',
    'currency' => 'EUR',
    'country' => 'GB',
    'description' => 'Account top-up',
    'email' => 'john.doe@example.com',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'method' => 'open_banking',
    'phoneNumber' => '+2348012345678',
    'referenceId' => 'INV-2024-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/deposits"

	payload := strings.NewReader("{\n  \"amount\": \"100.50\",\n  \"clientRef\": \"609eddec-9b97-4f41-8db3-ef9342263418\",\n  \"currency\": \"EUR\",\n  \"country\": \"GB\",\n  \"description\": \"Account top-up\",\n  \"email\": \"john.doe@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"method\": \"open_banking\",\n  \"phoneNumber\": \"+2348012345678\",\n  \"referenceId\": \"INV-2024-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/deposits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100.50\",\n  \"clientRef\": \"609eddec-9b97-4f41-8db3-ef9342263418\",\n  \"currency\": \"EUR\",\n  \"country\": \"GB\",\n  \"description\": \"Account top-up\",\n  \"email\": \"john.doe@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"method\": \"open_banking\",\n  \"phoneNumber\": \"+2348012345678\",\n  \"referenceId\": \"INV-2024-001\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"100.50\",\n  \"clientRef\": \"609eddec-9b97-4f41-8db3-ef9342263418\",\n  \"currency\": \"EUR\",\n  \"country\": \"GB\",\n  \"description\": \"Account top-up\",\n  \"email\": \"john.doe@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"method\": \"open_banking\",\n  \"phoneNumber\": \"+2348012345678\",\n  \"referenceId\": \"INV-2024-001\"\n}"

response = http.request(request)
puts response.read_body
{
  "amount": "100.50",
  "bic": "DEUTDEFF",
  "createdAt": "2024-01-15T10:30:00Z",
  "currency": "EUR",
  "description": "Account top-up",
  "iban": "GB82WEST12345698765432",
  "id": "a47ac10b-58cc-4372-a567-0e02b2c3d470",
  "method": "manual_deposit",
  "reference": "PAYIN-2024-001",
  "status": "pending",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Body

application/json
​
amount
string
required

Amount to deposit (as string to avoid floating-point precision issues). Must be greater than zero.

Pattern: ^[0-9]+(.[0-9]{1,8})?$
Example:

"100.50"

​
clientRef
string
required

Client reference for idempotency - must be unique per client

Example:

"609eddec-9b97-4f41-8db3-ef9342263418"

​
currency
string
required

Currency code (ISO 4217). Case-insensitive — normalized to uppercase.

Example:

"EUR"

​
country
string

Country code (ISO 3166-1 alpha-2)

Example:

"GB"

​
description
string

Optional description for the deposit

Maximum string length: 500
Example:

"Account top-up"

​
email
string

Email of the user initiating the payin. Required for NGN currency to generate dynamic virtual accounts.

Example:

"john.doe@example.com"

​
firstName
string

First name of the user initiating the payin. Required for NGN currency to generate dynamic virtual accounts.

Example:

"John"

​
lastName
string

Last name of the user initiating the payin. Required for NGN currency to generate dynamic virtual accounts.

Example:

"Doe"

​
method
enum<string>

Payment method to use for the deposit

Available options:
open_banking,
manual_deposit,
admin_deposit,
virtual_account,
crypto_deposit,
bank_deposit
Example:

"open_banking"

​
phoneNumber
string

Phone number of the user initiating the payin. Required for NGN currency to generate dynamic virtual accounts.

Example:

"+2348012345678"

​
referenceId
string

Optional external reference ID

Example:

"INV-2024-001"

Response

Deposit created successfully. Details for completing the transfer will be provided in the response.

​
amount
string
required

Deposit amount

Example:

"100.50"

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
currency
string
required

Currency code

Example:

"EUR"

​
id
string<uuid>
required

Unique identifier for the pay-in

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
method
enum<string>
required

Payment method used

Available options:
open_banking,
manual_deposit,
admin_deposit,
virtual_account,
crypto_deposit,
bank_deposit
Example:

"open_banking"

​
status
enum<string>
required

Current status of the pay-in

Available options:
pending,
processing,
completed,
failed,
cancelled,
refunding,
refunded,
in_review
Example:

"pending"

​
updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T10:35:00Z"

​
bic
string

BIC for manual deposits (if method is manual_deposit). For NGN payins, this contains the bank name assigned by the payin provider.

Example:

"DEUTDEFF"

​
description
string

Description of the deposit

Example:

"Account top-up"

​
iban
string

IBAN for manual deposits (if method is manual_deposit). For NGN payins, this contains the virtual account number assigned by the payin provider.

Example:

"GB82WEST12345698765432"

​
metadata
object

Provider-specific metadata containing payment details. For NGN payins, contains virtual account information (accountNumber, bankName, accountName, providerReference). Structure varies by payment method and provider.

Example:
{
  "accountName": "Zuba Business Name",
  "accountNumber": "3234567890",
  "bankName": "Wema Bank",
  "expiresAt": "2024-01-16T10:30:00Z",
  "providerReference": "ONUS-REF-1706510200000"
}
​
redirectUrl
string

Redirect URL for open banking flow (if method is open_banking)

Example:

"https://bank.example.com/auth?token=abc123"

​
reference
string

Payment reference. For NGN payins, this is the virtual account reference.

Example:

"PAYIN-2024-001"