API Reference

Cash In/Out Details

This page will help you get started with Cash In/Out.

Here are the sequence diagram of the endpoints of Cash In Out:

Get User By Phone Or Email

Funding

Withdraw


Errors

  • NotFoundException('User not found'): This error is thrown if a user with the provided ID is not found in the getOTP function.
  • NotFoundException('User not found'): This error is thrown in the getUserbyPhoneOrEmail if a user with the provided Email or PhoneNumber is not found.
  • NotFoundException('Funding method not found'): This error is thrown in the getUserbyPhoneOrEmail, funding, and withdraw functions if a funding method with the name Partner.AKISI is not found.
  • NotFoundException('Funding method not found'): This error is thrown in the funding function if a funding method with the currency GTQ is not found.
  • NotFoundException('Withdrawal method not found'): This error is thrown in the withdraw function if a withdrawal method with the currency GTQ is not found.
  • BadRequestException: This error is thrown when the data sent to the server does not meet the validations defined in the DTO. For example, if a field is required but not provided, or if the value of a field does not meet the defined constraints (such as an incorrect email format).