Payments
Get all payments
GET https://plugin.tebex.io/payments
Retrieve the latest payments (up to a maximum of 100) made on your webstore.
Query Parameters
limit
number
Limit the amount of payments returned.
Headers
X-Tebex-Secret
string
The secret key of a server.
[
{
"id": 1,
"amount": "4.99",
"date": "2016-01-27T15:40:19+0000",
"currency": {
"iso_4217": "GBP",
"symbol": "£"
},
"gateway": {
"id": 24,
"name": "PayPal"
},
"status": "Complete",
"email": "[email protected]",
"player": {
"id": 1,
"name": "Notch",
"uuid": "365bfa21803249ee9b634fe890c9d43f"
},
"packages": [
{
"id": 13,
"name": "Test Package"
}
],
"notes": [
"created_at": "2022-01-01 10:13:04",
"note": "Test Note"
],
"creator_code": "creator123"
},
{
"id": 2,
"amount": "9.99",
"date": "2016-01-18T11:37:38+0000",
"currency": {
"iso_4217": "GBP",
"symbol": "£"
},
"gateway": {
"id": 24,
"name": "PayPal"
},
"status": "Refund",
"email": "[email protected]",
"player": {
"id": 2,
"name": "7n",
"uuid": "ef01f2da1b284ad6ba8ba2aaf4432e22"
},
"packages": [
{
"id": 13,
"name": "Test Package"
}
],
"notes": [
"created_at": "2022-01-01 10:13:04",
"note": "Test Note"
],
"creator_code": "creator123"
}
]Get all payments paginated
GET https://plugin.tebex.io/payments?paged=1
Return all pages, paginated into pages of 25
Path Parameters
page
integer
The page number to return
{
"total": 146133,
"per_page": 25,
"current_page": 2,
"last_page": 5846,
"next_page_url": "https://plugin.tebex.io/payments?page=3",
"prev_page_url": "https://plugin.tebex.io/payments?page=1",
"from": 26,
"to": 50,
"data": [
{
"id": 123456,
"amount": "9.99",
"date": "2020-03-05T15:34:46+00:00",
"gateway": {
"id": 21,
"name": "Xsolla"
},
"status": "Complete",
"currency": {
"iso_4217": "GBP",
"symbol": "£"
},
"player": {
"id": 1,
"name": "Notch",
"uuid": "365bfa21803249ee9b634fe890c9d43f"
},
"packages": [
{
"id": 1234,
"name": "Test Package
}
],
"notes": [
"created_at": "2022-01-01 10:13:04",
"note": "Test Note"
],
"creator_code": "creator123"
}
]
}Retrieve a payment
GET https://plugin.tebex.io/payments/{transaction}
Retrieve a payment made on your webstore by transaction ID.
Path Parameters
transaction
string
The transaction ID of a payment.
Headers
X-Tebex-Secret
string
The secret key of a server.
{
"id": 1,
"amount": "4.99",
"status": "Complete",
"date": "2016-01-27T15:40:19+0000",
"currency": {
"iso_4217": "GBP",
"symbol": "£"
},
"player": {
"id": 1,
"name": "Notch",
"uuid": "365bfa21803249ee9b634fe890c9d43f"
},
"packages": [
{
"id": 100001,
"name": "Test Package"
},
{
"id": 100002,
"name": "Test Package 2"
}
],
"notes": [
"created_at": "2022-01-01 10:13:04",
"note": "Test Note"
],
"creator_code": "creator123"
}Get the required payment fields for a package
GET https://plugin.tebex.io/payments/fields/{package}
Returns an array of fields (custom variables, etc) required to be entered for a manual payment to be created for a package.
Path Parameters
package
string
The ID of a package.
Headers
X-Tebex-Secret
string
The secret key of a server.
[
{
"name": "price",
"value": "Custom Price",
"type": "numeric"
},
{
"name": "server",
"description": "Select a server to run commands on",
"type": "dropdown",
"options": [
{
"label": "Test Store",
"value": 7
},
{
"label": "Empty Server",
"value": 21
}
]
},
{
"name": "uname",
"description": "uname",
"type": "username",
"options": false
},
{
"name": "global",
"description": "Global level",
"type": "numeric",
"options": false
}
]Create a payment
POST https://plugin.tebex.io/payments
Create a manual payment in the same way as is possible from the control panel. One or more packages should be added to the payment, and the package commands will be processed in the same way as would be for a standard manual payment.
Headers
X-Tebex-Secret
string
The secret key of a server.
Request Body
note
string
A note to assign to the payment.
packages[][options]
object
An object of key => value pairs for the required option fields (as retrieved from the /fields endpoint).
packages[][id]
number
The ID of the package.
packages
array
Array of packages to add to the payment.
price
integer
The price of the payment.
ign
string
The username of the user to apply the payment to.
Update a payment
PUT https://plugin.tebex.io/payments/{transaction}
Update a payment.
Path Parameters
transaction
string
The transaction ID of the payment.
Headers
X-Tebex-Secret
string
The secret key of a server.
Request Body
username
string
The username that the payment should be applied to.
status
string
The status of the payment, either 'complete', 'chargeback' or 'refund'.
Create a payment note
POST https://plugin.tebex.io/payments/{transaction}/note
Create a note against a payment.
Path Parameters
transaction
string
The transaction ID of the payment.
Headers
X-Tebex-Secret
string
The secret key of a server.
Request Body
note
string
The note to add against the payment.
Last updated
Was this helpful?