Payments
These API endpoints are related to payments on Omniplex
Gets the required info needed for paypal payments.
Success
application/json- response
paypal_client_id?stringcurl -X GET 'https://spider.omniplex.gg/payments/paypal'{ "paypal_client_id": "string"}Creates a paypal order returning the URL. Use this to initiate a new paypal order in your client.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
credits?integerfor?stringfor_type?string"bot""server"gift?booleanWhether this is a gift for a listing the buyer doesn't own
gift_anonymous?booleanHide the buyer's name from the listing's owners
gift_message?stringid?stringname?stringpromo_code?stringSuccess
application/json- response
url?stringcurl -X POST 'https://spider.omniplex.gg/users/string/paypal' \ -H 'Content-Type: application/json' \ -d '{}'{ "url": "string"}Captures a paypal order, giving any needed perks. This is an internal endpoint.
ref_id*stringThe reference ID of the order returned during paypals redirect back to us
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X GET 'https://spider.omniplex.gg/payments/paypal/capture/string'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Gets the required info needed for stripe payments.
Success
application/json- response
stripe_public_key?stringcurl -X GET 'https://spider.omniplex.gg/payments/stripe'{ "stripe_public_key": "string"}Creates a stripe checkout session returning the URL. Use this to initiate a new stripe order in your client.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
credits?integerfor?stringfor_type?string"bot""server"gift?booleanWhether this is a gift for a listing the buyer doesn't own
gift_anonymous?booleanHide the buyer's name from the listing's owners
gift_message?stringid?stringname?stringpromo_code?stringSuccess
application/json- response
url?stringcurl -X POST 'https://spider.omniplex.gg/users/string/stripe' \ -H 'Content-Type: application/json' \ -d '{}'{ "url": "string"}Checks whether a promo code can be used for premium or Auto-vote and previews the discount. For premium, credits are applied before the code.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
code?stringcredits?integerplan?stringproduct?string"premium""autovote"Success
application/json- response
amount_off_cents?integerFixed amount taken off in US cents, if this is a fixed amount code
code?stringThe normalised promo code
description?stringStaff-written description of the offer
discount_cents?integerAmount the code takes off the first payment, in US cents
duration?stringHow long the discount lasts on Auto-vote: once, repeating or forever
duration_months?integerNumber of months the discount repeats for, when duration is repeating
percent_off?integerPercentage taken off, if this is a percentage code
product?stringThe product the code was checked against: premium or autovote
subtotal_cents?integerPrice in US cents before the code, after any credits
total_cents?integerFirst payment in US cents after the code
curl -X POST 'https://spider.omniplex.gg/users/string/promo-codes/check' \ -H 'Content-Type: application/json' \ -d '{}'{ "amount_off_cents": 0, "code": "string", "description": "string", "discount_cents": 0, "duration": "string", "duration_months": 0, "percent_off": 0, "product": "string", "subtotal_cents": 0, "total_cents": 0}Handles stripe payment webhooks. Not intended for public use and firewalled to only stripe IPs.
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X POST 'https://spider.omniplex.gg/payments/stripe/webhook'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Handles PayPal refund and dispute webhooks. Not intended for public use; every event is verified with PayPal before it is acted on.
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X POST 'https://spider.omniplex.gg/payments/paypal/webhook'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Gets the current set of premium plans available.
Success
application/json- response
auto_vote?Auto-vote subscription prices
credits_per_cent?integerHow many vote credits take one cent off a plan
max_credit_share?numberThe largest share of a plan's price credits can cover, from 0 to 1
doubleplans?array<>curl -X GET 'https://spider.omniplex.gg/payments/premium/plans'{ "auto_vote": { "included_slots": 0, "max_extra_slots": 0, "price_cents": 0, "slot_price_cents": 0, "yearly_price_cents": 0, "yearly_slot_price_cents": 0 }, "credits_per_cent": 0, "max_credit_share": 0.1, "plans": [ { "benefit": "string", "id": "string", "name": "string", "price": 0.1, "time_period": 0 } ]}Redeems a payment offer for a user given a redeem code
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
code*stringRedeem Code. Default codes: BOOSTPREMIUM -> special booster offer
application/json- body
credits?integerfor?stringfor_type?string"bot""server"gift?booleanWhether this is a gift for a listing the buyer doesn't own
gift_anonymous?booleanHide the buyer's name from the listing's owners
gift_message?stringid?stringname?stringpromo_code?stringSuccess
application/json- response
url?stringcurl -X POST 'https://spider.omniplex.gg/users/string/redeem-payment-offer?code=string' \ -H 'Content-Type: application/json' \ -d '{}'{ "url": "string"}