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"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.zuba.com/llms.txt

Use this file to discover all available pages before exploring further.

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)

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)

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
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
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 Payonus.

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 Payonus.

Example:

"GB82WEST12345698765432"

​
metadata
object

Provider-specific metadata containing payment details. For NGN payins via Payonus, 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 Payonus virtual account reference (onusReference).

Example:

"PAYIN-2024-001"