GitHub - maccca/promisepay-dotnet: A .NET package for invoking PromisePay RESTful API

#.NET SDK - PromisePay API

#1. Installation NuGet: Install PromisePay via NuGet package manager. The package name is 'PromisePay'.

Source: Download latest sources from GitHub, add project into your solution and build it.

#2. Configuration

Before interacting with PromisePay API, you need to generate an API token. See http://docs.promisepay.com/v2.2/docs/request_token for more information.

Once you have recorded your API token, configure the .NET package - see below.

Add the below configuration to either the App.config or Web.config file, depending if it is a Windows, or Web application.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <sectionGroup name="PromisePay">
      <section name="Settings" type="PromisePayDotNet.Settings.SettingsHandler,PromisePayDotNet" />
    </sectionGroup>
  </configSections>
  <PromisePay>
    <Settings>
      <add key="ApiUrl" value="https://test.api.promisepay.com" />
      <add key="Login" value="YOUR LOGIN" />
      <add key="Password" value="YOUR PASSWORD" />
      <add key="Key" value="YOUR API KEY" />
    </Settings>
  </PromisePay>
</configuration>

Environments

Prelive: https://test.api.promisepay.com
Production: https://secure.api.promisepay.com

Final configuration

PromisePay API package is build using Dependency Injection principle. It makes integration into your application easy and seamless.

You will need to setup your DI container to bind interfaces and implementations of the package together.

If you use Unity container, just invoke init method, as it's shown below:

	var container = new UnityContainer();
	PromisePayDotNet.DI.InitUnityContainer.Init(container);

If you use another container, just bind interfaces from PromisePayDotNet.Interfaces to PromisePayDotNet.Implementations. You may use any lifecycle; implementations are stateless.

Then, you can use repositories from package, by resolving interface with container, or passing dependencies into constructor.

For details and example, please consider the following MSDN article: https://msdn.microsoft.com/ru-ru/library/dn178463(v=pandp.30).aspx

#3. Examples ##Tokens

Example 1 - Request session token

The below example shows the request for a marketplace configured to have the Item and User IDs generated automatically for them.

var repo = container.Resolve<ITokenRepository>();
var session_token = new Token {
	current_user = "seller",
	item_name = "Test Item",
	amount = "2500",
	seller_lastname = "Seller",
	seller_firstname = "Sally",
	buyer_lastname = "Buyer",
	buyer_firstname = "Bobby",
	buyer_country = "AUS",
	seller_country = "USA",
	seller_email = "sally.seller@promisepay.com",
	buyer_email = "bobby.buyer@promisepay.com",
	fee_ids = "",
	payment_type_id = "2"		
};

#####Example 2 - Request session token The below example shows the request for a marketplace that passes the Item and User IDs.

var repo = container.Resolve<ITokenRepository>();
var session_token = new Token {
	current_user_id = "seller1234",
	item_name = "Test Item",
	amount = "2500",
	seller_lastname = "Seller",
	seller_firstname = "Sally",
	buyer_lastname = "Buyer",
	buyer_firstname = "Bobby",
	buyer_country = "AUS",
	seller_country = "USA",
	seller_email = "sally.seller@promisepay.com",
	buyer_email = "bobby.buyer@promisepay.com",
	external_item_id = "TestItemId1234",
	external_seller_id = "seller1234",
	external_buyer_id = "buyer1234",
	fee_ids = "",
	payment_type_id = "2"		
};

##Items

#####Create an item

var repo = container.Resolve<IItemRepository>();
var id = Guid.NewGuid().ToString();
var buyerId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var sellerId = "fdf58725-96bd-4bf8-b5e6-9b61be20662e"; //some user created before
var item = new Item
{
	Id = id,
	Name = "Test Item #1",
	Amount = 1000,
	PaymentType = PaymentType.Express,
	BuyerId = buyerId, //optional field
	SellerId = sellerId, //optional field
	//No fee at this stage, optional field
	Description = "Test item #1 description"
};
var createdItem = repo.CreateItem(item);

#####Get an item

var repo = container.Resolve<IItemRepository>();
var id = "36aa17fb-5ea6-432b-8363-8074ae02603d";
var gotItem = repo.GetItemById(id);

#####Get a list of items

var repo = container.Resolve<IItemRepository>();
var items = repo.ListItems();

#####Update an item

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var buyerId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var sellerId = "fdf58725-96bd-4bf8-b5e6-9b61be20662e"; //some user created before
var item = new Item
{
	Id = id,
	Name = "Test Item #1",
	Amount = 1000,
	PaymentType = PaymentType.Express,
	BuyerId = buyerId, //optional field
	SellerId = sellerId, //optional field
	//No fee at this stage, optional field
	Description = "Test item #1 description"
};

var updatedItem = repo.UpdateItem(item);

#####Delete an item

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var result = repo.DeleteItem(id)

#####Get an item status

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var status = repo.GetStatusForItem(id);

#####Get an item's buyer

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var buyer = repo.GetBuyerForItem(id);

#####Get an item's seller

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var seller = repo.GetSellerForItem(id);

#####Get an item's fees

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var fees = repo.ListFeesForItem(id);

#####Get an item's transactions

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var transactions = repo.ListTransactionsForItem(id);

#####Get an item's wire details

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var wireDetails = repo.GetWireDetailsForItem(id);

#####Get an item's BPAY details

var repo = container.Resolve<IItemRepository>();
var id = "bb2323cf-4838-4fcb-a288-933d0307523d";
var bPayDetails = repo.GetBPayDetailsForItem(id);

##Users

#####Create a user

var repo = container.Resolve<IUserRepository>();

var id = Guid.NewGuid().ToString();
var user = new User
{
    Id = id,
    FirstName = "Test",
    LastName = "Test",
    City = "Test",
    AddressLine1 = "Line 1",
    Country = "AUS",
    State = "state",
    Zip = "123456",
    Email = id + "@google.com"
};

var createdUser = repo.CreateUser(user);

#####Get a user

var repo = container.Resolve<IUserRepository>();
var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";

var user = repo.GetUserById(id);

#####Update a user

var repo = container.Resolve<IUserRepository>();
var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";

var user = new User
{
    Id = id,
    FirstName = "Test",
    LastName = "Test",
    City = "Test",
    AddressLine1 = "Line 1",
    Country = "AUS",
    State = "state",
    Zip = "123456",
    Email = id + "@google.com"
};

var updatedUser = repo.UpdateUser(user);

#####Get a list of users

	var repo = container.Resolve<IUserRepository>();
	var users = repo.ListUsers();

#####Delete a User

	var repo = container.Resolve<IUserRepository>();
	var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	repo.DeleteUser(id);

#####Get a user's card accounts

	var repo = container.Resolve<IUserRepository>();
	var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var accounts = repo.ListCardAccountsForUser(id);

#####Get a user's PayPal accounts

	var repo = container.Resolve<IUserRepository>();
	var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var accounts = repo.ListPayPalAccountsForUser(id);

#####Get a user's bank accounts

	var repo = container.Resolve<IUserRepository>();
	var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var accounts = repo.ListBankAccountsForUser(id);

#####Get a user's items

	var repo = container.Resolve<IUserRepository>();
	var id = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var items = repo.ListItemsForUser(id);

#####Set a user's disbursement account

	var repo = container.Resolve<IUserRepository>();
	var userId = "871f83ce-c55d-43ce-ba97-c65628d041a9";	
	var accountId = "d077620f-f207-451c-abea-9ed430ea2cbf";	
	bool result = repo.SetDisbursementAccount(userId, accountId);

##Item Actions #####Make payment

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var accountId = "d077620f-f207-451c-abea-9ed430ea2cbf";
	var item = repo.MakePayment(itemId, accountId);

#####Request payment

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var item = repo.RequestPayment(itemId);

#####Release payment

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var releaseAmount = 123;
	var item = repo.ReleasePayment(itemId, releaseAmount);

#####Request release

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var releaseAmount = 123;
	var item = repo.RequestRelease(itemId, releaseAmount);

#####Cancel

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var item = repo.Cancel(itemId);

#####Acknowledge wire

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var item = repo.AcknowledgeWire(itemId);

#####Acknowledge PayPal

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var item = repo.AcknowledgePayPal(itemId);

#####Revert wire

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var item = repo.RevertWire(itemId);

#####Request refund

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var refundAmount = 123;
	var refundMessage = "refund message";
	var item = repo.RequestRefund(itemId, refundAmount, refundMessage);

#####Refund

	var repo = container.Resolve<IItemRepository>();
	var itemId = "871f83ce-c55d-43ce-ba97-c65628d041a9";
	var refundAmount = 123;
	var refundMessage = "refund message";
	var item = repo.Refund(itemId, refundAmount, refundMessage);

##Card Accounts #####Create a card account

var repo = container.Resolve<ICardAccountRepository>();
var userId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var account = new CardAccount
{
	UserId = userId,
	Active = true,
	Card = new Card
	{
		FullName = "Batman",
		ExpiryMonth = "11",
		ExpiryYear = "2020",
		Number = "4111111111111111",
		Type = "visa",
		CVV = "123"
	}
};
var createdAccount = repo.CreateCardAccount(account);
var id = createdAccount.Id;

#####Get a card account

var repo = container.Resolve<ICardAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotAccount = repo.GetCardAccountById(accountId);

#####Delete a card account

var repo = container.Resolve<ICardAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var result = repo.DeleteCardAccount(accountId); //result should be true
var gotAccount = repo.GetCardAccountById(accountId); //gotAccount.Active should be false

#####Get a card account's users

var repo = container.Resolve<ICardAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotUser = repo.GetUserForCardAccount(accountId);

##Bank Accounts #####Create a bank account

var repo = container.Resolve<IBankAccountRepository>();
var userId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var account = new BankAccount
{
	UserId = userId,
	Active = true,
	Bank = new Bank
	{
		BankName = "Test bank, inc",
		AccountName = "Test account",
		AccountNumber = "8123456789",
		AccountType = "savings",
		Country = "AUS",
		HolderType = "personal",
		RoutingNumber = "123456"
	}
};
var createdAccount = repo.CreateBankAccount(account);

#####Get a bank account

var repo = container.Resolve<IBankAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotAccount = repo.GetBankAccountById(accountId);

#####Delete a bank account

var repo = container.Resolve<IBankAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var result = repo.DeleteBankAccount(accountId); //result should be true
var gotAccount = repo.GetBankAccountById(accountId); //gotAccount.Active should be false

#####Get a bank account's users

var repo = container.Resolve<IBankAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotUser = repo.GetUserForBankAccount(accountId);

##PayPal Accounts #####Create a PayPal account

var repo = container.Resolve<IPayPalAccountRepository>();
var userId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var account = new PayPalAccount
{
	UserId = userId,
	Active = true,
	PayPal = new PayPal
	{
		Email = "aaa@bbb.com"
	}
};
var createdAccount = repo.CreatePayPalAccount(account);

#####Get a PayPal account

var repo = container.Resolve<IPayPalAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotAccount = repo.GetPayPalAccountById(accountId);

#####Delete a PayPal account

var repo = container.Resolve<IPayPalAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var result = repo.DeletePayPalAccount(accountId); //result should be true
var gotAccount = repo.GetPayPalAccountById(accountId); //gotAccount.Active should be false

#####Get a PayPal account's users

var repo = container.Resolve<IPayPalAccountRepository>();
var accountId = "14a74a3c-8358-4c99-bcf2-4c6ed7454747";
var gotUser = repo.GetUserForPayPalAccount(accountId);

##Companies

#####Create a company

var repo = container.Resolve<ICompanyRepository>();
var userId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var company = new Company
{
	UserId = userId,
	Name = "Acme Co",
	LegalName = "Acme Co Pty Ltd",
	TaxNumber = "1231231",
	ChargeTax = true,
	AddressLine1 = "123 Test St",
	AddressLine2 = "",
	City = "Melbourne",
	State = "VIC",
	Zip = "3000",
	Country = "AUS",
};
var createdCompany = repo.CreateCompany(company);

#####Get a company

var repo = container.Resolve<ICompanyRepository>();
var id = "36aa17fb-5ea6-432b-8363-8074ae02603d";
var gotItem = repo.GetCompanyById(id);

#####Get a list of companies

var repo = container.Resolve<ICompanyRepository>();
var companies = repo.ListCompanies();

#####Update a company

var repo = container.Resolve<ICompanyRepository>();
var id = "ec9bf096-c505-4bef-87f6-18822b9dbf2c";
var userId = "ec9bf096-c505-4bef-87f6-18822b9dbf2c"; //some user created before
var company = new Company
{
	Id = id,
	Name = "Acme Co",
	LegalName = "Acme Co Pty Ltd",
	TaxNumber = "1231231",
	ChargeTax = true,
	AddressLine1 = "123 Test St",
	AddressLine2 = "",
	City = "Melbourne",
	State = "VIC",
	Zip = "3000",
	Country = "AUS",
};

var updatedCompany = repo.UpdateCompany(company);

##Fees #####Get a list of fees

var repo = container.Resolve<IFeeRepository>();
var fees = repo.ListFees();

#####Get a fee

var repo = container.Resolve<IFeeRepository>();
var id = "79116c9f-d750-4faa-85c7-b7da36f23b38";
var fee = repo.GetFeeById(id);

#####Create a fee

var repo = container.Resolve<IFeeRepository>();
var feeId = Guid.NewGuid().ToString();
var createdFee = repo.CreateFee(new Fee
{
	Id = feeId,
	Amount = 1000,
	Name = "Test fee #1",
	FeeType = FeeType.Fixed,
	Cap = "1",
	Max = "3",
	Min = "2",
	To = "buyer"
});

##Transactions #####Get a list of transactions

var repo = container.Resolve<ITransactionRepository>();
var transactions = repo.ListTransactions();

#####Get a transactions

var repo = container.Resolve<ITransactionRepository>();
var id = "79116c9f-d750-4faa-85c7-b7da36f23b38";
var transaction = repo.GetTransaction(id);

#####Get a transaction's users

var repo = container.Resolve<ITransactionRepository>();
var id = "79116c9f-d750-4faa-85c7-b7da36f23b38";
var user = repo.GetUserForTransaction(id);

#####Get a transaction's fees

var repo = container.Resolve<ITransactionRepository>();
var id = "79116c9f-d750-4faa-85c7-b7da36f23b38";
var fee = repo.GetFeeForTransaction(id);

#4. Contributing 1. Fork it ( https://github.com/PromisePay/promisepay-dotnet/fork ) 2. Create your feature branch (git checkout -b my-new-feature) 3. Commit your changes (git commit -am 'Add some feature') 4. Push to the branch (git push origin my-new-feature) 5. Create a new Pull Request

Name		Name	Last commit message	Last commit date
Latest commit History 86 Commits
PromisePayDotNet.Tests		PromisePayDotNet.Tests
PromisePayDotNet		PromisePayDotNet
packages		packages
.gitignore		.gitignore
.travis.yml		.travis.yml
PromisePayDotNet.sln		PromisePayDotNet.sln
Readme.md		Readme.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PromisePayDotNet.Tests

PromisePayDotNet.Tests

PromisePayDotNet

PromisePayDotNet

packages

packages

.gitignore

.gitignore

.travis.yml

.travis.yml

PromisePayDotNet.sln

PromisePayDotNet.sln

Readme.md

Readme.md

Repository files navigation

Example 1 - Request session token

About

Releases

Packages

Languages

maccca/promisepay-dotnet

Folders and files

Latest commit

History

Repository files navigation

Example 1 - Request session token

About

Resources

Stars

Watchers

Forks

Languages