Payments

Operations related to payments

Get payments

get

Retrieves information about your payments. Use the page parameter to paginate results. Optionally, filter by a specific user using the identifier parameter.

Accepted identifiers: email, username, eosid, ue4_id, steam_username, steam_id, player_id, minecraft_uuid, discord_id, discord_username, fivem_xPlayer_id, fivem_citizen_id, minecraft_username.

Authorization:

• Requires a valid JWT Bearer token.

• The token must include the permission: read-payments.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

The page number to retrieve.

Default: 1

max_pageintegerOptional

The maximum number of elements per page. This number must be between 5-50.

Default: 50

identifierstringOptional

Specify an identifier for a user to filter subscriptions. If omitted, payments for all users will be included.

Responses

200

Successful operation

application/json

payment_countnumberOptionalExample: 356

403

Missing or invalid Tip4Serv API Key

application/json

500

Internal server error

application/json

get/store/payments

GET /v1/store/payments HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "payments": [
    {
      "id": 10203,
      "status": "Paid",
      "cart": "VIP+",
      "sub_id": 1,
      "date": 1761234717,
      "amount": 6.49,
      "currency": "USD",
      "username": "RandomUser123",
      "identifier": "discord_id:274785054121525248",
      "player_id": "C84A567",
      "gateway": "PayPal",
      "details_page": "https://tip4serv.com/dashboard/payment-details?id=10203"
    }
  ],
  "payment_count": 356
}

Get payment

get

Retrieves information about your payment. Useful if you want to get the different commands to be delivered.

Authorization:

• Requires a valid JWT Bearer token.

• The token must include the permission: read-payments.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

The payment ID to retrieve.

Default: 10669

Responses

200

Successful operation

application/json

idnumberRequired

Unique identifier of the payment.

Example: 10203

statusstringRequired

Status of the payment. Accepted values: Processed, Paid, Refunded, Pending, Refused

Example: Paid

cartstringOptional

The products name which were bought in the payment.

Example: VIP+

sub_idnumberOptional

Eventual subscription id to which the payment is related to.

Example: 1

datenumberRequired

Payment creation timestamp expressed in your store timezone.

Example: 1761234717

amountnumberRequired

Amount which was paid by the customer in the payment.

Example: 6.49

currencystringRequired

Currency which was used for the payment.

Example: USD

usernamestringRequired

Username which was used for the payment.

Example: RandomUser123

identifierstringRequired

Identifier used for identifying the user. Accepted identifiers:
email, username, eosid, ue4_id, steam_id, player_id,
minecraft_uuid, discord_id,fivem_citizen_id, minecraft_username.

Example: discord_id:274785054121525248

gatewaystringRequired

Gateway used for the payment. Accepted values: PayPal, `Stripe

Example: PayPal

details_pagestringOptional

View more details about the payment on this page.

Example: https://tip4serv.com/dashboard/payment-details?id=10203

403

Missing or invalid Tip4Serv API Key

application/json

500

Internal server error

application/json

get/store/payment/{id}

GET /v1/store/payment/{id} HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 10203,
  "status": "Paid",
  "cart": "VIP+",
  "sub_id": 1,
  "date": 1761234717,
  "amount": 6.49,
  "currency": "USD",
  "username": "RandomUser123",
  "identifier": "discord_id:274785054121525248",
  "gateway": "PayPal",
  "details_page": "https://tip4serv.com/dashboard/payment-details?id=10203",
  "server_actions": [
    {
      "id": 1,
      "state": "Execute",
      "str": "inventory.giveto 76561198380145423 scientist 5",
      "product_id": 14,
      "server_id": 23
    }
  ],
  "cart_details": [
    {
      "id": 202,
      "name": "MVP+",
      "price": 4.99,
      "quantity": 1
    }
  ]
}