Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
studentId
string<uuid>
required
amount
number
required
Required range: 0 < x <= 1000000000000
description
string
required
Required string length: 1 - 2000
dueDate
string | null
required
externalId
string
Required string length: 1 - 160
currency
string
default:USD
Required string length: 3
Pattern: ^[A-Za-z]{3}$
status
enum<string>
default:pending
Available options:
pending,
paid,
overdue,
cancelled,
refunded
paidAt
string | null

Response

201 - application/json

Created payment

data
object
required