Deposit

Creates a checkout session for a customer wallet deposit and returns a checkoutUrl to redirect the customer to. Once the customer completes payment, the wallet is credited automatically via webhook.

Body

customerId

*String

ID of the customer to deposit into.

channel

*String

Channel — use "WALLET".

currency

*String

3-letter ISO currency code (e.g. NGN).

amount

*Number

Amount to deposit in major units.

*String

Customer email shown on the checkout page.

callbackUrl

*String

URL the provider redirects to after payment.

provider

String

Specific provider to use. Omit to auto-select using health-ranked pick.

metadata

Object

Arbitrary key-value pairs passed through to the provider.

POST

/ v2/wallet/deposit

Endpoint URL(TEXT)

https://api.sandbox.switch.tulupay.com/v2/wallet/deposit

https://api.sandbox.switch.tulupay.com/v2/wallet/deposit

Request Body

{
  "customerId": "cus_ada",
  "channel": "WALLET",
  "currency": "NGN",
  "amount": 5000,
  "email": "ada.obi@example.com",
  "callbackUrl": "https://acme.app/callback"
}

{
  "customerId": "cus_ada",
  "channel": "WALLET",
  "currency": "NGN",
  "amount": 5000,
  "email": "ada.obi@example.com",
  "callbackUrl": "https://acme.app/callback"
}

Response(JSON)

// Click 'Try now' to see the response