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": "<string>",
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "amount": 123
    }
  ],
  "purchase_order": "<string>",
  "charging_method": "immediately"
}'
{
  "invoice_id": "<string>",
  "checkout": {
    "id": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
  • Option 1

  • Option 2

type
enum<string>
required
Available options:
one_time
customer_id
string
required
items
object[]
required
purchase_order
string | null
charging_method
enum<string>
required
Available options:
immediately

Response

200 - application/json
invoice_id
string
required

Payment invoice ID.

checkout
object

One-time payment checkout session.