Payment Pages
Create Page
POST
https://api.lahza.io/page
Create a payment page on your integration
Headers
Name | Type | Description |
---|---|---|
authorization* | String | Set value to Bearer SECRET_KEY |
content-type* | String | Set value to application/json |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Name of page |
redirect_url | String | If you would like Lahza to redirect someplace upon successful payment, specify the URL here. |
metadata | object | Extra data to configure the payment page including, logo image |
slug | String | URL slug you would like to be associated with this page. Page will be accessible at https://pay.lahza.iom/[slug] |
amount | String | Amount should be in agora if currency is ILS, qirsh, if currency is JOD, and cents, if currency is USD |
description | String | A description for this page |
custom_fields | array | If you would like to accept custom fields, specify them here. |
List Pages
GET
https://api.lahza.io/page
List payment pages available on your integration.
Query Parameters
Name | Type | Description |
---|---|---|
perPage | integer | Specify how many records you want to retrieve per page. If not specify we use a default value of 50. |
page | integer | Specify exactly what page you want to retrieve. If not specify we use a default value of 1. |
to | datetime | A timestamp at which to stop listing page e.g. 2023-09-24T00:00:05.000Z, 2023-09-21 |
from | datetime | A timestamp from which to start listing page e.g. 2023-09-24T00:00:05.000Z, 2023-09-21 |
Headers
Name | Type | Description |
---|---|---|
authorization* | String | Set value to Bearer SECRET_KEY |
Fetch Page
GET
https://api.lahza.io/page/:id_or_slug
Get details of a payment page on your integration.
Path Parameters
Name | Type | Description |
---|---|---|
id_or_slug* | String | The page ID or slug you want to fetch |
Headers
Name | Type | Description |
---|---|---|
authorization* | String | Set value to Bearer SECRET_KEY |
Update Page
PUT
https://api.lahza.io/page/:id_or_slug
Update a payment page details on your integration
Headers
Name | Type | Description |
---|---|---|
authorization* | String | Set value to Bearer SECRET_KEY |
id_or_slug | String | Page ID or slug |
content-type* | String | Set value to application/json |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Name of page |
amount | integer | Amount should be in aghora if currency is ILS, qirsh, if currency is JOD, and cents, if currency is USD |
description | String | A description for this page |
active | boolean | Set to false to deactivate page url |
Check Slug Availability
GET
https://api.lahza.io/page/check_slug_availability/:slug
Check the availability of a slug for a payment page.
Path Parameters
Name | Type | Description |
---|---|---|
slug | String | URL slug to be confirmed |
Headers
Name | Type | Description |
---|---|---|
authorization* | String | Set value to Bearer SECRET_KEY |
Last updated