Skip to main content
POST
/
CardPayment
Register card payment
curl --request POST \
  --url https://api.trysynch.com/CardPayment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "mobileNumber": "<string>",
  "cardType": "<string>",
  "transactionStatus": "<string>",
  "email": "<string>",
  "patientReferenceNumber": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyReferenceId": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Use /auth/token to obtain access token. Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer eyJhbGci...'

Body

​
amount
integer<int32>
required

The payment amount in cents

​
mobileNumber
string
required

The payer's phone number in international format

​
cardType
string
required

The type of card used (e.g., Visa, Mastercard)

​
transactionStatus
string
required

Status of the card transaction. Allowed values: Pending, Succeeded, Failed, Cancelled, Refunded

​
email
string | null

The payer's email address for notifications

​
patientReferenceNumber
string | null

An optional reference number for the payer

​
companyId
string<uuid> | null

The SynchPay identifier for the company

​
companyReferenceId
string | null

Your external identifier for the company

Response

200

OK

Last modified on April 8, 2026