POST
/
payments

The API payload for creating a payment on behalf of a sub-account works exactly like the standard merchant one.

The only difference is that you need to specify the platform_on_behalf_of field with the sub-account ID.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Sellix-Merchant
string

The name of the store to perform actions on via the API

Body

application/json
email
string
required

Email of the customer. Should you want to handle emails on your own, pass to this field a company email to which PDF receipts of orders will be sent for accounting and log purposes.

white_label
boolean
required

Whether or not you want to handle the payments UI. If false, return_url must be specified as it is the website where we will redirect the customer once he has paid through our platform. If true, we will return a full invoice object in the response for you to handle. You can receive updates over invoices and handle subsequent logics through our webhooks.

title
string

Required if product_id and cart are null. Defines the title of the purchase, can be the digital good's name or a brief summary of what the customer is paying for.

product_id
string

If specified value, currency and custom_fields will be taken from the product details.

product_plans
object

Required for subscriptions 2.0. Specified which plan to use for the invoice.

cart
object

Other than product_id, a cart object can be specified if multiple products need to be purchased through the API.

gateway
enum<string>

If null, the customer will be asked automatically to choose a gateway on the Sellix hosted /payment page. If product_id is specified, the gateway must be on in the product's gateways array.

Available options:
PAYPAL,
STRIPE,
SKRILL,
PERFECT_MONEY,
CASH_APP,
BINANCE,
BITCOIN,
LITECOIN,
ETHEREUM,
BITCOIN_CASH,
NANO,
MONERO,
SOLANA,
RIPPLE,
BINANCE_COIN,
USDC,
USDT,
TRON,
BITCOIN_LN,
CONCORDIUM,
POLYGON,
PEPE,
DAI,
WETH,
APE,
SHIB,
USDC_NATIVE,
DOGECOIN,
PYTH,
BONK,
JUP,
JITO,
WEN,
RENDER,
MOBILE,
HNT
gateways
enum<string>[]
Available options:
PAYPAL,
STRIPE,
SKRILL,
PERFECT_MONEY,
CASH_APP,
BINANCE,
BITCOIN,
LITECOIN,
ETHEREUM,
BITCOIN_CASH,
NANO,
MONERO,
SOLANA,
RIPPLE,
BINANCE_COIN,
USDC,
USDT,
TRON,
BITCOIN_LN,
CONCORDIUM,
POLYGON,
PEPE,
DAI,
WETH,
APE,
SHIB,
USDC_NATIVE,
DOGECOIN,
PYTH,
BONK,
JUP,
JITO,
WEN,
RENDER,
MOBILE,
HNT
paypal_apm
enum<string>

If gateway is PAYPAL, a paypal_apm (PayPal Alternative Payment Method) can be specified. To retrieve the available PayPal APM for a specific customer session, please refer to the PayPal SDK using window.paypal.FUNDING and fundingSource to filter out available methods. You can also use our documentation on how to process white_label payments.

Available options:
bancontact,
eps,
trustly,
mercado,
paylater,
sepa,
venmo,
blik,
giropay,
ideal,
mybank,
sofort,
przelewy24,
credit
credit_card
boolean

If gatewa is PAYPAL and no paypal_apm is passed, specify credit_card true to land the customer on the PayPal managed credit card page instead of the onboarding login.

lex_payment_method
string
deprecated

DEPRECATED: If gateway is LEX_HOLDINGS_GROUP, method to be used for the customer to pay.

value
number

Required if product_id and cart are null. The customer will be asked to pay for this amount.

currency
enum<string>

Required if product_id and cart are null, defines the currency of value.

Available options:
CAD,
HKD,
ISK,
PHP,
DKK,
HUF,
CZK,
GBP,
RON,
SEK,
IDR,
INR,
BRL,
RUB,
HRK,
JPY,
THB,
CHF,
EUR,
MYR,
BGN,
TRY,
CNY,
NOK,
NZD,
ZAR,
USD,
MXN,
SGD,
AUD,
ILS,
KRW,
PLN
quantity
integer

Can be passed with either product_id null or not. The value or product's price will be multiplied by this amount.

Required range: x > 1
coupon_code
string

Pass a Sellix coupon code to apply a discount over the invoice.

confirmations
integer

Cryptocurrency confirmations required to count a transaction over the total crypto amount needed.

custom_fields
object

key-value JSON having as key the custom field name and as value the custom field value inserted by the customer. Custom fields can both be used as inputs from the customers but also as metadata for invoices, letting you pass hidden fields for internal referencing.

fraud_shield
object

Customer details to be used by our fraud shield in order to score potential fraud attempts.

webhook
string

DEPRECATED: Webhook URL to which updates regarding this payment (invoice) will be sent.

return_url
string

Response

200 - application/json
status
integer
data
object
error
string
message
string
env
string
log
object

Was this page helpful?

Custody dashboard link