This tutorial describes how to connect the Tikkie API to the sandbox environment along with the APIs functionality.
You can also:
Step 1 - Get an API key
- Go to Get started, and complete Step 2 - Create an account.
- In the top navigation bar, click My Apps.
- Click on the app you created.
- Copy the API Key number.
Step 2 - Create a sandbox appToken
Important: In a production environment,
appTokenis created in the Tikkie Business Portal. The functionality described in this step is only available in the sandbox environment.
To create an new application which has all rights enabled, using API key you obtained in the previous step, execute: POST Sandbox App.
The response contains an
appToken which is used in subsequent requests.
Step 3 - Create a payment request
To create a payment, using the
appToken you created in Step 2, execute: POST Payment Request.
This operation creates a new payment request as specified by the body of the request, and returns a
paymentRequestToken which is used to access your payment request.
The operation also returns a
url that is used to direct the user to where the request can be paid.
Step 4 - Retrieve payment request details
To retrieve details of payment requests, use one of the following operations:
GET Payment Request: Returns the details of one payment request, specified by a
GET Payment Requests: Returns a list of payment requests based on the query parameters passed in the request. This list is paginated.
Step 5 - Retrieve payment details
When a user pays a payment request, the transaction is marked as a 'payment'. This indicates that the payment is completed.
To retrieve payment details, use one of the following operations:
GET Payment: returns the details of one payment, specified by a
GET Payments: returns a list of payments based on the query parameters passed in the request. This list is paginated.
Step 6 - Create a refund
To create a refund, execute: POST Refund.
This operation initiates a refund on a specific payment and returns a
refundToken which can be used to retrieve details.
Step 7 - Retrieve refund details
To retrieve refund details, execute: GET Refund.
This operation returns the details of one refund, specified by a
Step 8 - Set up a subscription
To receive notifications when a payment is paid or when a refund is been paid out, set up an subscription using: POST Notification Subscription.
HTTP post requests will be made to the specified
url containing information about the payment or refund in the body of the request.
Step 9 - To cancel a subscription
To cancel a subscription and stop receiving notifications, execute: DELETE Notification Subscription.