Get paid faster by creating and sharing payment requests.
This tutorial describes the functionality of the Tikkie Payment Request API.
You can also:
Step 1 - Get an access token
The Tikkie Payment Request API uses client assertion based OAuth authentication. For more information, see Signed JSON web token.
To use this API, you must obtain an access token from the OAuth API with the following scope:
Important: This tutorial assumes that you have a valid access token.
Step 2 - Create a platform
Create a platform using the POST platform operation.
This operation creates a new platform as specified by the body of a request, and returns a
platformToken which is used to access your platform. Save this token, or use GET Platforms to retrieve it.
Important: You can make only two platforms per account.
Step 3 - Add users to the platform
Add users to your platform using the POST user operation.
This operation creates a new user and adds them to an existing platform. The user is specified by the body of the call. The platform is specified by the
platformToken that is provided in the path.
For each user a
userToken and a
bankAccountToken is generated. These can be used to create new payments or to view payments for this user.
Important: You can only create users in the sandbox environment. In the production environment this is completed by Tikkie Business Support.
Step 4 - Create payment requests
Create payment requests on behalf of a user using the POST payment request operation.
To create a request, you must use the
bankAccountToken that were generated in the previous step. The response contains the payment URL, which you can be sent to the person that must fulfill the payment. It also contains a
paymentRequestToken, which can be used for future reference to this payment request.
paymentRequestToken to reference this payment request.
paymentRequestURL to direct the user to a page where the request can be paid.
Step 5 - Access payment requests
To access payment requests, use one of the following calls:
GET payment request: returns the status of one payment request, specified by a
paymentRequestToken. This operation fetches a single payment request, identified on the basis of a payment token in the path.
GET user payment requests: fetches all payment requests for an existing user. The user is specified in the path by the
userToken. The results are paginated based on query parameters. It is also possible to filter based on creation date using query parameters.