YouCan Pay Dart SDK #

This is Dart/Flutter SDK for YouCan Pay APIs, which helps you to communicate with YouCan Pay in your Dart/Flutter project easily, and make your life more easier.

Key features #

Easy to use methods that reflects the API endpoints based on it's documentation.
Developer friendly, you will feel at home working with this package.
Supports all the API endpoints.
Configure once, use everywhere.

Code progress (100%) #

✅ Payment
✅ Account
✅ Currencies
✅ Transfers
✅ Invoices
✅ Balance History
✅ Withdrawals
✅ Deposit

Test progress (0%) #

[.] Payment
[.] Account
[.] Currencies
[.] Transfers
[.] Invoices
[.] Balance History
[.] Withdrawals
[.] Deposit

Usage #

Quick Overview #

This package provides access to APIs via modules reflecting the base APIs documentation, each module of the SDK can be accessed via the one & only singleton of it, which is YouCanPay.instance, these are wat you can access via this singleton:

  YouCanPay.instance.account;
  
  YouCanPay.instance.balanceHistory; 
  
  YouCanPay.instance.currencies; 
  
  YouCanPay.instance.deposits; 
  
  YouCanPay.instance.invoices; 
  
  YouCanPay.instance.payments; 
  
  YouCanPay.instance.transfers;
  
  YouCanPay.instance.withdrawals;

copied to clipboard

And each module will contain a set of methods that relates to it, as example to access the account's register API, you can use the following code:

RegisterResponse registerResponse = await YouCanPay.instance.account.register(
   email: "john@example.com",
   firstName: "John",
   lastName: "Doe",
   password: "123456789",
   phone: "+212611223344",
);

copied to clipboard

Error handling #

All methods of this package will throw an exception if something went wrong from Youcan Pay ends, you can catch and handle them as you want.

Way 1

You can trigger the YouCanPayException exception & catch it, then you will be able to use it's message.. like this:

try {  
    RegisterResponse registerResponse = await YouCanPay.instance.account.register(...);
    print(registerResponse.message);
  } on YouCanPayException catch (e) {
    print(e.message); // This will print the error message from the APIs.
    print(e.statusCode); // This will print the status code of the response.
  } catch(e) {
    print(e);
  }

copied to clipboard

Way 2

The APIs exposes some pre-defined error codes that you can expect to happen while developing, with this package you have the option to execute an action based on each one, like this:

try {  
    RegisterResponse registerResponse = await YouCanPay.instance.account.register(...);
    print(registerResponse.message);
  } on YouCanPayException catch (e) {
    switch (e) {
      case YouCanPayNotFoundException():
        print("Not found");
        break;

      case YouCanPayBadRequestException():
        print("Bad request");
        break;

      case YouCanPayServerErrorException():
        print("Server error");
        break;

      case YouCanPayUnAuthorizedException():
        print("UnAuthorized");
        break;

      case YouCanPayUnprocessableEntityException():
        print("UnprocessableEntity");
        break;

      default:
        print("Unknown error");
    }

    print(e.message);
    print(e.statusCode);    
  
    } catch(e) {
    print(e);
  }

copied to clipboard

It is up to your case to handle the error as you want. as a bonus, you can also use the statusCode to handle the error.

Documentation #

Payment #

Tokenize Payment

You can tokenize a new payment by using the tokenize method.

  TokenizeResponse response = await YouCanPay.instance.payments.tokenize(
      amount: 150000,
      priKey: "pri_sandbox_9f410153-b941-47f5-9154-c1981",
      currency: "MAD",
      orderId: "orderId",
    );
    
    print(response.token); // ...

copied to clipboard

CashPlus Gateway

This will process the payment using CashPlus Gateway

    final res = await YouCanPay.instance.payments.cashPlusInit(
    pubKey: "YOUR_PUBLIC_KEY",
     tokenId: "PAYMENT_TOKEN",
    );

    print(res.tokenId);
    print(res.transactionId);

copied to clipboard

Card Gateway Sale

This will process a payment using a sale operation. currently, the package supports only direct payments that are authorized and don't required 3ds authorization.

    final res = await YouCanPay.instance.payments.pay(
      pubKey: "YOUR_PUBLIC_KEY",
      tokenId: "PAYMENT_TOKEN",
      cardHolderName: "Anas FIKHI",
      creditCard: 4242424242424242,
      cvv: 112,
      expireDate: YouCanPayExpireDate(month: 10, year: 24),
    );

    print(res.message); // ...
    print(res.transactionId); // ...

copied to clipboard

Card Gateway Authorization

This will process a payment using a authorization operation. This is faster than the sale operation as it only authorizes the payment. The capture is then done asynchronously within 30 seconds of the authorization.

    final res = await YouCanPay.instance.payments.authorize(
      pubKey: "YOUR_PUBLIC_KEY",
      tokenId: "PAYMENT_TOKEN",
      cardHolderName: "Anas FIKHI",
      creditCard: 4242424242424242,
      cvv: 112,
      expireDate: YouCanPayExpireDate(month: 10, year: 24),
    );

    print(res.message); // ...
    print(res.transactionId); // ...

copied to clipboard

Account #

Register for an account

You can create a new account by using the register method.

   final res = await YouCanPay.instance.account.register(
     email: "john@example.com",
     firstName: "John",
     lastName: "Doe",
     password: "123456789",
     phone: "+212611223344", 
   );

    print(res.message);

copied to clipboard

Authentication

You can authenticate a user by using the authenticate method, it will return a AuthenticateResponse object that contains the user's token that you can use in the next requests.

   final res = await YouCanPay.instance.account.login(
     emailOrPhone: email,
     password: password,
   );
   
   print(res.token);

copied to clipboard

Account Information

You can get a user related informations by using the me method that requires only the user's token.

   final res = await YouCanPay.instance.account.me(
     token: "THE_USER_TOKEN",
   );
   
   print(res.email);
   print(res.address);
   print(res.phone);

copied to clipboard

Update Account Information

In order to update a user's account informations, you can use the updateAccount method:


   final res = await YouCanPay.instance.account.updateAccount(
     token: "TOKEN_OF_THE_USER",
     firstName: "anas fikhi",
     adress: "...",
   );
   
   print(res.message);

copied to clipboard

Update Account Password

In order to update a user's password, you can use the updatePassword method:


   final res = await YouCanPay.instance.account.updatePassword(
     token: "TOKEN_OF_THE_USER",
     password: "newPassword",
   );
   
   print(res.message);

copied to clipboard

Account Stats

In order to get a user's account stats, you can use the stats method:

   final res = await YouCanPay.instance.account.stats(
     token: "TOKEN_OF_THE_USER",
     fromDate: DateTime.now().subtract(Duration(days: 5)),
     toDate: DateTime.now(),
     interval: YouCanPayStatsInterval.thisWeek,
    );
   
   print(res.totalRevenue);
   print(res.paidTransactionsByDates);

copied to clipboard

Refresh Auth Token

To refresh a user's auth token, you can use the refreshToken method:

   final res = await YouCanPay.instance.account.refreshToken(
     token: "TOKEN_OF_THE_USER",
   );
   
   print(res.token); // The new token

copied to clipboard

Logout

To logout a user, you can use the logout method. This methpd will invalidate the current user's token, so he will not be able to use it anymore until he authenticates again.

   final res = await YouCanPay.instance.account.logout(
     token: "TOKEN_OF_THE_USER",
   );
   
   print(res.message);

copied to clipboard

Currencies #

Conversion rates

You can get the convertion rates of a currency by using the convertionRates method:

   final res = await YouCanPay.instance.currencies.conversionRates(
     token: "TOKEN_OF_THE_USER",
   );
   
   print(res.baseCurrency);
   print(res.conversionRates["MAD"]);
   print(res.conversionRates["USD"]);

copied to clipboard

Transfers #

Create a transfer

You can create a new transfer by using the create method:

   final res = await YouCanPay.instance.transfers.create(
     token: "TOKEN_OF_THE_USER",
     amount: 1000,
     identifier: "work@gwhyyy.com",
   );

    print(res.id); // The transfer's id

copied to clipboard

List transfers

To list all the transfers of a user, you can use the transfers method:

   final res = await YouCanPay.instance.transfers.transfers(
     token: "TOKEN_OF_THE_USER",
   );

    print(res.data.map((e) => e.id).toList()); // The list of transfers ids

copied to clipboard

Recent Recipients

To get the recent recipients, you can use the recentRecipients method:

   final res = await YouCanPay.instance.transfers.recentRecipients(
     token: "TOKEN_OF_THE_USER",
   );

    print(res.data.map((e) => e.id).toList()); // The list of recent recipients ids

copied to clipboard

Invoices #

Create an invoice

You can create a new invoice by using the create method:

  final res = await YouCanPay.instance.invoices.create(
    token: "TOKEN_OF_THE_USER",
    amount: 4000,
    contactOption: 1,
    name: "anas fikhi",
    currency: "MAD",
  );

  print(res.id);
  print(res.alias);
  print(res.displayAmount);

copied to clipboard

List invoices

To list all the invoices of a user, you can use the invoices method:

  final res = await YouCanPay.instance.invoices.invoices(
    token: "TOKEN_OF_THE_USER",
  );

  print(res.data.map((e) => e.id).toList()); // The list of invoices ids

copied to clipboard

Tokenize an invoice

You can tokenize an invoice by using the tokenize method:

  final res = await YouCanPay.instance.invoices.tokenize(
    token: "TOKEN_OF_THE_USER",
    invoiceId: "INVOICE_ID",
  );

  print(res.tokenID);

copied to clipboard

Balance History #

List balance history

To list all the balance history of a user, you can use the balanceHistory method:

  final res = await YouCanPay.instance.balanceHistory.history(
    token: "TOKEN_OF_THE_USER",
  );

  print(res.data.map((e) => e.id).toList()); // The list of balance history items ids

copied to clipboard

Withdrawals #

Create a withdrawal

You can create a new withdrawal by using the create method:

    final res = await YouCanPay.instance.withdrawals.create(
      token: "TOKEN_OF_THE_USER",
      paymentMethod: YouCanPayPaymentsMethod.bank_account,
      amount: 500,
    );

    print(res.message);

copied to clipboard

List withdrawals

To get a list of withdrawals, you can use the withdrawals method:

    final res = await YouCanPay.instance.withdrawals.withdrawals(
      token: "TOKEN_OF_THE_USER",
    );

    print(res.data.map((e) => e.id).toList()); // The list of withdrawals ids

copied to clipboard

Deposit #

Tokenize

In order to tokenize a deposit, you can use hte tokenize method:


    final res = await YouCanPay.instance.deposits.tokenize(
      token: "TOKEN_OF_THE_USER",
      amount: 1000,
      currency: 'MAD',
    );

    print(res.tokenId);

copied to clipboard

Want to contribute? #

You are welcome to contribute to this project, just fork it and make a pull request, we will be happy to review it and merge it, these are some tasks that you can work on:

[] Find and correct mistakes in the documentation.
[] Handle unexpected behaviors if they happen.
[] Refactor, or add new funcionalities to the package.
[] Make the package more developer friendly.

Issues #

If you find any issue, please report it here

youcan_pay 0.8.2 youcan_pay: ^0.8.2 copied to clipboard

Metadata

YouCan Pay Dart SDK #

Key features #

Code progress (100%) #

Test progress (0%) #

Usage #

Quick Overview #

Error handling #

Way 1

Way 2

Documentation #

Payment #

Tokenize Payment

CashPlus Gateway

Card Gateway Sale

Card Gateway Authorization

Account #

Register for an account

Authentication

Account Information

Update Account Information

Update Account Password

Account Stats

Refresh Auth Token

Logout

Currencies #

Conversion rates

Transfers #

Create a transfer

List transfers

Recent Recipients

Invoices #

Create an invoice

List invoices

Tokenize an invoice

Balance History #

List balance history

Withdrawals #

Create a withdrawal

List withdrawals

Deposit #

Tokenize

Want to contribute? #

Issues #

← Metadata

Publisher

Weekly Downloads

Metadata

Documentation

License

Dependencies

More

youcan_pay 0.8.2
youcan_pay: ^0.8.2 copied to clipboard