Are you a new customer and would like some help with understanding how to integrate? Here are some example use cases! Please note you might need to integrate with endpoints from 2 products (and hence 2 openAPI locations) in order to execute your use case. Hence, for each step, we clearly point out the product where you can find the endpoint.
| Info |
|---|
Assumptions:
|
I want to allow end-users to make
...
payments
...
Authorize the client with the client credentials you received from finAPI. This call should be executed from Access.
| Code Block |
|---|
POST /oauth/token |
Authorize yourself as a client and create a new finAPI user. This call should be executed from Access.
| Code Block |
|---|
POST /api/v1/users |
Now authorize yourself as an end-user, and you will get access to all end-user/business-related endpoints. This call should be executed from Access.
| Code Block |
|---|
POST /oauth/token |
In order to initiate a standalone payment (payment without having to import your account first) provide the API parameters relevant to you and trigger the endpoint. This call should be executed from Web Form 2.0.
| Code Block |
|---|
POST /api/webForms/standalonePayment |
...
| Code Block |
|---|
GET /api/webForms/{id} |
...
| Code Block |
|---|
GET /api/v1/payments?ids=$paymentId |
without having to import their accounts
We have detailed the steps here. Feel free to look around the documentation, it describes various possible payment workflows.
I want to set up a Dashboard for
...
For each of the end-users you created, authorize yourself as the end-user (sequentially) and get all the Web Forms they initiated. This call should be executed from Web Form 2.0.
| Code Block |
|---|
GET /api/webForms |
...
For each Web Form in the returned API object, gather all the payment ID(s). You could also gather Web Form statistics based on Web Form status, Web Form type.
...
payments
We have detailed the steps /wiki/spaces/FPPD/pages/2753724457. Feel free to contact our Customer Success Team (support@finapi.io) in case you have further questions.