Process payment link for given ID
POST
/v1/payment-links/{paymentLinkId}/process
curl \
--request POST 'https://classmanager.test/v1/payment-links/{paymentLinkId}/process' \
--header "Content-Type: application/json" \
--data '{"paymentIntentId":"pi_xxxxxxxx"}'
Request example
{
"paymentIntentId": "pi_xxxxxxxx"
}
Response examples (200)
{
"paymentLink": {
"id": "pay_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"transactionId": "trn_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"createdAt": "2023-12-05 14:30:41"
},
"company": {
"id": "co_123123123123",
"name": "My Dance Stdio",
"slug": "my-dance-studio",
"email": "john@example.com",
"phone": "(123) 456 7890",
"createdAt": "2025-05-04T09:42:00Z",
"logo": "https://example.com/logo.png",
"address": {
"id": "loc_xxxxxxxxxxx",
"companyId": "co_123123123123",
"entityId": "ent_xxxxxxxxxxx",
"address1": "123 Main St",
"address2": "Apt 123",
"town": "Springfield",
"state": "IL",
"countryCode": "US",
"zip": "12345"
},
"settings": {
"general": {
"id": "cos_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"timezone": "Africa/Abidjan",
"locale": "en-IE",
"industry": "cheer",
"size": "not-started-yet",
"use12HourClock": true,
"brandColor": "#6354e8",
"brandColors": {
"50": "#ffead7",
"100": "#ffddc1",
"200": "#ffcfab",
"300": "#ffc196",
"400": "#ffad80",
"500": "#ff9f6a",
"600": "#ff9154",
"700": "#ff833e",
"800": "#ff7528",
"900": "#ff6712",
"950": "#ff5a00"
},
"startDayOfWeek": "monday"
},
"tax": {
"id": "cotx_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"enabled": true,
"taxIdLabel": "Tax ID",
"taxIdNumber": "123123123",
"taxMode": "inclusive"
},
"trial": {
"id": "cotr_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"price": 0,
"enableOnPortal": true,
"maxCapacityPerLesson": 0,
"limitedCapacity": true
},
"billing": {
"id": "cobl_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"stripeId": "acct_123123123123",
"currency": "USD",
"billingTiming": "advance",
"billingDayOfMonth": 13
},
"enrolment": {
"id": "coen_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"ageCutOffType": "first_day_of_season",
"ageCutOffDate": "06-24",
"ageCutOffDays": "7"
},
"integrations": {
"stripe": {
"id": "coiss_xxxxxxxxxxxxxxxxxxxxxxxxxx",
"connectAccountId": "acct_123123123",
"region": "us",
"feeSchedule": "standard"
}
}
},
"countryCode": "US"
},
"family": {
"id": "fml_123123123123",
"companyId": "co_123123123123",
"name": "Potter",
"joinedAt": "2023-12-05",
"invitationStatus": "not_invited",
"profilePicture": "https://",
"deletedAt": "2023-12-05 14:30:41",
"archivedAt": "2023-12-05 14:30:41",
"createdAt": "2023-12-05 14:30:41"
},
"debitAggregateTransaction": {
"aggregateId": "trn_xxxxxxxxxxx",
"transaction": {
"id": "trn_123123123123",
"companyId": "co_123123123123",
"familyId": "fml_123123123123",
"familyName": "Potter",
"relatedTransactionId": "trn_123123123123",
"type": "debit",
"date": "2023-12-05",
"description": "This is a transaction",
"deletedAt": "2023-12-05 14:30:41"
},
"details": [
{
"details": {
"id": "trn_123123123123",
"companyId": "co_123123123123",
"transactionId": "trn_123123123123",
"type": "manual-debit",
"amount": 100,
"description": "This is a transaction",
"deletedAt": "2023-12-05 14:30:41"
},
"relatedEntities": [
{
"id": "trn_123123123123",
"companyId": "co_123123123123",
"transactionDetailId": "trnd_123123123123",
"entityId": "cls_123123123123"
}
]
}
],
"stats": {
"total": 1000,
"subtotal": 950,
"discountTotal": 30,
"taxTotal": 20
}
},
"creditAggregateTransaction": {
"aggregateId": "trn_xxxxxxxxxxx",
"transaction": {
"id": "trn_123123123123",
"companyId": "co_123123123123",
"familyId": "fml_123123123123",
"familyName": "Potter",
"relatedTransactionId": "trn_123123123123",
"type": "debit",
"date": "2023-12-05",
"description": "This is a transaction",
"deletedAt": "2023-12-05 14:30:41"
},
"details": [
{
"details": {
"id": "trn_123123123123",
"companyId": "co_123123123123",
"transactionId": "trn_123123123123",
"type": "manual-debit",
"amount": 100,
"description": "This is a transaction",
"deletedAt": "2023-12-05 14:30:41"
},
"relatedEntities": [
{
"id": "trn_123123123123",
"companyId": "co_123123123123",
"transactionDetailId": "trnd_123123123123",
"entityId": "cls_123123123123"
}
]
}
],
"stats": {
"total": 1000,
"subtotal": 950,
"discountTotal": 30,
"taxTotal": 20
}
},
"paymentIntent": {
"id": "pm_1234567890",
"clientSecret": "pm_1234567890_secret_xxxxxxxx",
"amount": 1999,
"status": "canceled",
"paymentMethod": {
"id": "pm_123456789",
"type": "acss_debit",
"isDefault": true,
"data": {
"brand": "amex",
"country": "US",
"expiryMonth": 12,
"expiryYear": 2023,
"cardNumber": "************4242",
"last4": "4242"
}
},
"charge": {
"id": "pm_1234567890",
"amount": 1999,
"amountCaptured": 1999,
"amountRefunded": 1999,
"currency": "usd",
"refunded": false,
"refunds": [
{
"id": "pm_1234567890",
"amount": 1999,
"currency": "usd",
"status": "pending",
"createdAt": "2023-12-05"
}
]
}
}
}
Response examples (422)
{
"statusCode": 42.0,
"messages": [
"string"
],
"exception": {}
}