Create a payment

Creates a new payment for a given user

POST /Payment/Create

Create a payment

cURL

curl --request POST \
  --url https://api.trysynch.com/Payment/Create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "registrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contactNumber": "<string>",
  "emailAddress": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyReferenceId": "<string>",
  "shortDescription": "<string>",
  "feePayer": "<string>",
  "reference": "<string>",
  "attachment": "<string>",
  "dueDate": "2023-12-25",
  "enableDebitAuth": true,
  "debitAuthLimit": 123,
  "enableAutoPay": true,
  "autoPayLimit": 123,
  "metadata": {}
}
'

200

{
  "paymentRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountMask": "<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

application/jsontext/jsonapplication/*+json

amount · integer<int32>

registrationId · string<uuid> | null

contactNumber · string | null

emailAddress · string | null

companyId · string<uuid> | null

companyReferenceId · string | null

shortDescription · string | null

feePayer · string | null

reference · string | null

attachment · string | null

dueDate · string<date> | null

enableDebitAuth · boolean | null

debitAuthLimit · integer<int32> | null

enableAutoPay · boolean | null

autoPayLimit · integer<int32> | null

metadata · object

Show child attributes

Response

200

text/plain

OK

paymentRequestId · string<uuid>

accountMask · string | null