Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Quick links
Anchor | ||||
---|---|---|---|---|
|
Endpoints
Method | Endpoint | Description |
---|---|---|
POST | token | Create an access token |
POST | intent | Create an intent |
POST | token/refresh | Refresh the access token |
POST | intent/refresh | Refresh the intent |
GET | intent/{id} | Return the intent |
PATCH | intent/{id} | Update the intent |
POST | element | Return required details to populate payment form |
POST | cc/process | Processes credit card payment and redirects to |
GET | transaction/{id} | Returns transactions details |
POST | {notification_url} | Redirects to notification URL |
POST | dd/process | Create customer, their bank account, mandate and payment request using the customer details and returns to user defined return URL after successful payment request creation |
POST | dd/callback | Return payment request status using payment id in later phase |
POST | ob/process | Process open banking request with transaction details. On success it will provide the bank server redirect URL. |
POST | ob/callback/{id} | Upon successful or failed payment on the bank server end, bank will return the response to this API request. Here, it will be handled and sent to the Merchant’s provided return URL. |
Anchor | ||||
---|---|---|---|---|
|
Errors
Name | Description |
---|---|
200 OK | Everything worked as expected. |
400 Bad Request | Often due to missing a required parameter. |
401 Unauthorized | No valid API key provided. |
402 Request failed | The parameters were valid but the request failed. |
403 Forbidden | The API key doesn't have permissions to perform the request. |
404 Not Found | The requested resource doesn't exist. |
409 - Conflict | Conflicts with another request (perhaps using the same key). |
429 - Too Many Requests | Too many requests hit the API too quickly. |
500 | Something went wrong |
Anchor | ||||
---|---|---|---|---|
|
Markup Conventions
Item | Description | ||
---|---|---|---|
| Code in the body of test | ||
| Code block | ||
| Variable in code | ||
GET | Get method | ||
POST | Post method | ||
PUT | Put method | ||
PATCH | Patch method | ||
DELETE | Delete method | ||
(optional) | All attributes are mandatory, unless identified optional keyword. |