Follow

WePay API FAQ

In this article

Where does the WePay API fit in?

How does the API work?

Can anybody use it?

What can't I use the API for?

Can I set up payments on my own website?

Can I create subscription payments?

Can I let my users accept payments into their own accounts?

How safe is the API?

Does WePay protect me from fraud?

How does WePay protect me from fraud?

What's the best way to get started?

Do I need an application?

What's the difference between stage and production?

How long does it take my application do get approved?

I’m an advanced developer. How do I jump right in?

What programming languages can I use?

What’s the best way to test out the WePay API?

Where can I ask a question if I need help?

What is an access_token?

What is an account_id? Where can I find mine?

How do refunds to my customers work?

Do refunds cost me anything?

 

Where does the WePay API fit in?

The WePay API exposes a number of WePay’s core functions to developers who would like to customize the process of accepting payments. With it, a developer can be more flexible in designing payments for their own websites and applications.

 

Back to top

 

How does the API work?

On a very high level, the WePay API allows websites and applications to make calls on WePay’s payment engine.

 

Back to top

 

Can anybody use it?

Any WePay user is free to use the WePay API, although coding experience will be required. To comfortably interact with the API, a user should have a solid background in web development. A list of Software Development Kits can be found here for various languages.

 

Back to top

 

What can’t I use the API for?

WePay’s terms of service still apply for users of the API. If you can’t sell it with the core platform, you won’t be able to sell it with the API.

 

Back to top

 

Can I set up payments on my own website?

Absolutely! You can use the WePay API to accept payments on your own website in a number of different ways. Current sellers use it for everything from simple checkout to complex marketplace integrations.

 

If you’re interested in using WePay for checkout on your own website, but aren’t completely comfortable with coding, make sure you take a look at WePay’s payment buttons first - it might save you some time!

 

Back to top

 

Can I create subscription payments?

Yes, WePay’s API gives you a flexible way to create recurring charges. You can use it for anything from yearly product subscriptions to recurring rent charges. Most subscription charges are created using the /preapproval call

 

Back to top

 

Can I let my users accept payments into their own accounts?

Yes, a use case in which you need your own users to be able to accept payments is the WePay API’s specialty. WePay’s own flexible account structure makes it very easy to quickly provision accounts to your users via an Oauth2 connect. Money collected through your application can easily be stored in these accounts until your users are ready to access it.

 

Back to top

 

How safe is the API?

WePay takes security very seriously. We encrypt our data in a PCI compliant environment, and apply our rigorous standards to our API as well. If you'd like more information, you can read about it here.

 

Back to top

 

Does WePay protect me from fraud?

Absolutely. Out of the necessity to protect the hundreds of thousands of people that use the WePay core platform, WePay has developed state of the art systems to detect fraudulent or inappropriate usage of the product. This same technology applies to all payments run through our API. The WePay engine protect all of your payments equally well.

 

Back to top

 

How does WePay protect me from fraud?

With each transaction, WePay analyzes a variety of helpful data, all of which helps to create an accurate picture of payee and payer.

 

Back to top

 

What’s the best way to get started?

Easy! Just log in to WePay and click the WePay API application button. Referential documentation can be found at wepay.com/developer!

 

Back to top

 

Do I need an application?

Yes, your WePay API application serves as the repository for all of your transactional data. You can use it to analyze your transaction history.

 

Back to top

 

What’s the difference between stage and production?

stage.wepay.com is our staging server. It’s the best place to test your application before pushing over to production. The two environments are otherwise almost identical except that new changes will be pushed to stage a day or two earlier than to production.

 

Back to top

 

How long does it take my application do get approved?

API applications are usually approved within 24 hours.

 

Back to top

 

I’m an advanced developer. How do I jump right in?

Check out our calls and reference sections on our developer page, and feel free to browse through our examples. Also, you may get started on our production server right away if you feel like you don’t need to be testing on Stage.

 

Back to top

 

What programming languages can I use?

WePay’s API is language-agnostic, but we do provide SDKs for the most popular languages, including PHP, Ruby, Python, and NodeJS.

 

Back to top

 

What’s the best way to test out the WePay API?

Use WePay’s staging server! You can create an application on stage.wepay.com and run tests just as you would on our production server. Quick note, though - you will need two sets of login credentials - one for staging and one for production.

 

Back to top

 

Where can I ask a question if I need help?

Send us an email at api@wepay.com!

 

Back to top

 

What is an access_token?

Your access_token is the key by which you get your application or website to interact with the WePay API. Without it, you won’t be able to do much. It’s a random series of numbers and letters that is completely unique to your application.

 

Back to top

 

What is an account_id? Where can I find mine?

Your access_token and account_id can be found on the first visible page of your API application when you log in. If you don’t see it, click the API Keys section header.

 

Back to top

 

 

How do refunds to my customers work?

You can easily issue refunds to your customers via the checkout/refund call. The WePay API also supports partial refunds, if that applies to your use case.

 

Back to top

 

Do refunds cost me anything?

Refunds issued via the API don’t cost your account anything, and your customer receives 100% of the original charge back.

 

Back to top

           

For additional information and documentation, please visit wepay.com/developer.

Was this article helpful?
3 out of 3 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk