ndeipipayments APIv1 · 0.1.0-draftAPI reference

Guides

Test in the sandbox

Use the sandbox endpoints to drive every path your integration has to handle, including the unhappy ones. They fire exactly the events production would, signed the same way.

What to simulate

To testCall
An approved, incomplete or rejected userPOST /sandbox/users/{user_id}/kyc with kyc_status and optional rejection_reasons
A deposit arrivingPOST /sandbox/deposits with a deposit_account_id or a one-off transfer_id
Over- or under-paymentThe same call with an amount that differs from what was expected
A deposit held for review, or returnedThe same call with "outcome": "in_review" or "returned"
A payout landing, bouncing or failingPOST /sandbox/transfers/{transfer_id}/payout_outcome with completed, returned or undeliverable

Before you go live

Run your integration through this list end to end:

  1. Two users onboarded, with your app handling each KYC status.
  2. A transfer refused while a user isn't approved yet.
  3. A deposit credited, with its webhook received and its signature verified.
  4. A send retried with the same idempotency key that moved money only once.
  5. A payout returned by the bank and refunded to the wallet.
  6. Every wallet's history summing to its balance.