Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
transactions
/
{transactionId}
/
confirmation-requests
Request confirmation for transaction
curl --request POST \
  --url https://api.halth.com/v1/businesses/{businessId}/transactions/{transactionId}/confirmation-requests \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "payment_confirmation",
  "isRetry": false
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "contactValue": "<string>",
  "verified": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "verificationCode": "<string>",
  "verifiedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
businessId
string
required
​
transactionId
string
required

Body

application/json
​
action
enum<string>
required

Type of confirmation to request

Available options:
payment_confirmation,
claim_confirmation,
claim_cancellation
Example:

"payment_confirmation"

​
isRetry
boolean
default:false

True if this is a retry of a previous confirmation and try another channel.

Example:

false

Response

201 - application/json
​
id
string
required
​
createdAt
string<date-time>
required
​
contactType
enum<string>
required
Available options:
sms,
email
​
contactValue
string
required
​
verified
boolean
required
​
action
enum<string>
required
Available options:
payment_confirmation,
claim_confirmation,
claim_cancellation
​
expiresAt
string<date-time>
required
​
verificationCode
string
​
verifiedAt
string<date-time>