Skip to main content

1. Check availability

Ask what TZS needs for your account. The answer lists the required fields per customer type and account type.

2. Create the customer

Required for an individual: firstname, lastname. See Virtual account requirements for every combination.
The customer is created with kycStatus incomplete or pending. Anything missing for TZS can be added later with PATCH /customers/{uuid} before you request the account.

3. Request the account

You must have a webhook secret set up first, or the request returns 400 with webhook_secret_required. The response depends on the currency. For TZS, expect active: active: Ready. Show the bank details to your payer.
If the request is rejected straight away you get 422 with the reason in errors[0].reason and no account is created. If it is rejected later you receive virtual_account.failed with a reason. See Webhooks.

4. Show the details to your payer

Show these fields from bankDetails: How your payer sends the money:
  1. Send a transfer to the account number shown, in Tanzanian shillings, by TIPS, TISS or mobile money.

5. Receive the payment

When the payment arrives you receive virtual_account.payment.received. Amounts are decimal strings in TZS; destinationAmount is in USD, after any fees.
Verify the signature before you trust it, and use data.transaction.reference to ignore repeats. See Webhooks.

Things to handle

  • TZS accounts are dedicated only, and need only the customer’s name.
  • A payment can be held for review. You receive virtual_account.payment.manual_review with a review.reason, then received or rejected after a decision.
  • GET /virtual-accounts/{uuid} returns the current status at any time, and POST /virtual-accounts/{uuid}/deactivate stops the account accepting payments.