API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Payments
Create payment
Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session
POST
/
v1
/
payments
curl --request POST \
--url https://api.hyperline.co/v1/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "one_time",
"customer_id": "cus_Typ0px2W0aiEtl",
"items": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"amount": 24000
}
],
"products": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"amount": 24000
}
],
"purchase_order": "<string>",
"custom_note": "<string>",
"charging_method": "immediately",
"payment_method_type": "transfer",
"payment_method_id": "pm_1ryTrMj4TTAT1N"
}'
{
"invoice_id": "<string>",
"checkout": {
"id": "<string>",
"url": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Create payment payload
The body is of type object
.
The body is of type object
.
The body is of type object
.
Response
200 - application/json
The reference to the created invoice and optionally the checkout
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "one_time",
"customer_id": "cus_Typ0px2W0aiEtl",
"items": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"amount": 24000
}
],
"products": [
{
"id": "itm_3kXODDF42QXtnL",
"name": "Product name",
"amount": 24000
}
],
"purchase_order": "<string>",
"custom_note": "<string>",
"charging_method": "immediately",
"payment_method_type": "transfer",
"payment_method_id": "pm_1ryTrMj4TTAT1N"
}'
{
"invoice_id": "<string>",
"checkout": {
"id": "<string>",
"url": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.