Charging a Saved Card

Create and charge a payment request using a saved card payment method.

Use POST /Payment/ChargeSavedCard to create a payment request for a registered customer and charge a saved card payment method.

Endpoint

• URL: https://api.synchpay.com/Payment/ChargeSavedCard
• Method: POST
• Authorization: Bearer <AccessToken>

The access token is obtained from /auth/token using your ClientId and ClientSecret.

Request Body

Parameter	Type	Description	Required
Amount	integer	Amount to charge in cents.	Yes
LocationId	string	UUID of the company location receiving the payment.	Yes
RegistrationId	string	Unique ID of the user registration.	Yes
PaymentMethodId	string	Saved card payment method ID.	Yes
ShortDescription	string	Brief description of the payment.	No
FeePayer	string	Party responsible for the payment fee.	No
Attachment	string	Base64-encoded PDF attachment.	No
DueDate	string	Due date in YYYY-MM-DD format.	No

Use company locations to find the LocationId, then list saved card payment methods to find the PaymentMethodId for that location.

Example Request

{
  "Amount": 5000,
  "LocationId": "4d8ab11b-0322-4bf9-921f-39d753b0530c",
  "RegistrationId": "6e8d9257-bd5f-45cf-8f29-6d0ae8a6d991",
  "PaymentMethodId": "pm_123",
  "ShortDescription": "Follow-up visit",
  "FeePayer": "partner",
  "DueDate": "2026-08-03"
}

Response

Field	Type	Description
PaymentRequestId	string	Created payment request ID.
RegistrationId	string	User registration ID.
Status	string	Resulting card payment request status.
ChargedAmount	integer	Amount charged in cents.

{
  "PaymentRequestId": "ce0e3549-a83e-4cf6-bb5c-1d50a21d8af7",
  "RegistrationId": "6e8d9257-bd5f-45cf-8f29-6d0ae8a6d991",
  "Status": "success",
  "ChargedAmount": 5000
}