Skip to main content
POST
/
v1
/
payment-notices
Create payment notice
curl --request POST \
  --url https://api.clinikapi.com/v1/payment-notices \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "paymentId": "<string>",
  "recipientId": "<string>",
  "amount": {
    "value": 123,
    "currency": "<string>"
  },
  "created": "<string>",
  "providerId": "<string>",
  "paymentDate": "<string>",
  "payeeId": "<string>",
  "paymentStatus": "<string>",
  "requestId": "<string>",
  "responseId": "<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
​
paymentId
string
required
Maximum string length: 128
​
recipientId
string
required
Maximum string length: 128
​
amount
object
required
​
created
string
Maximum string length: 50
​
providerId
string
Maximum string length: 128
​
paymentDate
string
Maximum string length: 50
​
payeeId
string
Maximum string length: 128
​
paymentStatus
string
Maximum string length: 100
​
requestId
string
Maximum string length: 128
​
responseId
string
Maximum string length: 128

Response

201

Payment notice created