Skip to main content
POST
/
v1
/
payment-reconciliations
Create payment reconciliation
curl --request POST \
  --url https://api.clinikapi.com/v1/payment-reconciliations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "paymentDate": "<string>",
  "paymentAmount": {
    "value": 123,
    "currency": "<string>"
  },
  "created": "<string>",
  "paymentIssuerId": "<string>",
  "requestId": "<string>",
  "requestorId": "<string>",
  "disposition": "<string>",
  "period": {
    "start": "<string>",
    "end": "<string>"
  },
  "detail": [
    {
      "type": "<string>",
      "requestId": "<string>",
      "submitterId": "<string>",
      "payeeId": "<string>",
      "date": "<string>",
      "amount": {
        "value": 123,
        "currency": "<string>"
      }
    }
  ],
  "processNote": [
    {
      "text": "<string>",
      "type": "<string>"
    }
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
active,
cancelled,
draft
paymentDate
string
required
Maximum string length: 50
paymentAmount
object
required
created
string
Maximum string length: 50
paymentIssuerId
string
Maximum string length: 128
requestId
string
Maximum string length: 128
requestorId
string
Maximum string length: 128
outcome
enum<string>
Available options:
queued,
complete,
error,
partial
disposition
string
Maximum string length: 2000
period
object
detail
object[]
Maximum array length: 50
processNote
object[]
Maximum array length: 20

Response

201

Payment reconciliation created