Getting Started

Introduction
Authentication
Errors
Rate Limits

Open APIs

Payment Requests API
Payments API
Merchants API

Getting Started

Introduction
Authentication
Errors
Rate Limits

Open APIs

Payment Requests API
Payments API
Merchants API

Payment Request Notification

post https://api.clik2pay.com/open/v1/payment-requests/{paymentRequestId}/notifications

Sends a notification for a payment request.

URL Expired

The URL for this request expired after 30 days.

Path Params

paymentRequestId

string

required

The identifier of the payment request.

Body Params

preferredDeliveryMode

string

The preferred method to use to notify the payer of the request. Defaults to payment request deliveryMode. If the payment request deliveryMode is NONE and both payer email and mobileNumber are set then the default is EMAIL. If the payment request deliveryMode is NONE and only mobileNumber is set then the default is SMS.

Responses

Response body

object

event

object

The most recent event of the payment request, reflecting the change in status.

status

string

The status of a payment request.

CREATED SCHEDULED EMAIL_SENT SMS_SENT ACTIVE PROCESSING PAID SETTLED FAILED CANCELLED DECLINED EXPIRED DEPOSIT_FAILED LINK_FOLLOWED

dateTime

date-time

The date and time of the event.

payload

object

Properties related to the event.

Has additional fields

links

array of objects

Links to resources related to the payment request.

links

object

rel

string

The relation of the linked resource

href

uri

The target URL of the linked resource

Response body

object

message

string

A message describing the reason for the error response

errors

array of objects

A list of detailed errors that indicate problems with the request. Usually empty unless the response was a Bad Request (400)

errors

object

property

string

The property or object name that failed to be read

error

string

A descriptive message describing the reason for the failure

401

Unauthorized

Response body

object

message

string

A message describing the reason for the error response

errors

array of objects

A list of detailed errors that indicate problems with the request. Usually empty unless the response was a Bad Request (400)

errors

object

property

string

The property or object name that failed to be read

error

string

A descriptive message describing the reason for the failure

Response body

object

message

string

A message describing the reason for the error response

errors

array of objects

A list of detailed errors that indicate problems with the request. Usually empty unless the response was a Bad Request (400)

errors

object

property

string

The property or object name that failed to be read

error

string

A descriptive message describing the reason for the failure

Response body

object

message

string

A message describing the reason for the error response

errors

array of objects

A list of detailed errors that indicate problems with the request. Usually empty unless the response was a Bad Request (400)

errors

object

property

string

The property or object name that failed to be read

error

string

A descriptive message describing the reason for the failure

Response body

object

message

string

A message describing the reason for the error response

errors

array of objects

A list of detailed errors that indicate problems with the request. Usually empty unless the response was a Bad Request (400)

errors

object

property

string

The property or object name that failed to be read

error

string

A descriptive message describing the reason for the failure

Updated 9 months ago

Cancel a Payment Request

Refund a Payment Request

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.clik2pay.com/open/v1/payment-requests/paymentRequestId/notifications \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 9 months ago

Cancel a Payment Request

Refund a Payment Request

Did this page help you?

Getting Started
Introduction
Authentication
Errors
Rate Limits

Open APIs
Payment Requests API
Download Batch Result Fileget
Batch Submit Payment Requestpost
Batch Payment Request Listget
Refund Statusget
List Refundsget
Refund a Payment Requestpost
Payment Request Notificationpost
Cancel a Payment Requestpost
Payment Request Statusget
Create Payment Requestpost
List Payment Requestsget
Payments API
Cancel a Paymentpost
Payment Statusget
Create Paymentpost
Merchants API
Fetch Merchant Deposit Transactionsget
Fetch Merchant Depositsget
Fetch a Merchant's Brandget
Fetch a Merchantget
List merchants that are accessible by the logged in userget

Getting Started
Introduction
Authentication
Errors
Rate Limits

Open APIs
Payment Requests API
Download Batch Result Fileget
Batch Submit Payment Requestpost
Batch Payment Request Listget
Refund Statusget
List Refundsget
Refund a Payment Requestpost
Payment Request Notificationpost
Cancel a Payment Requestpost
Payment Request Statusget
Create Payment Requestpost
List Payment Requestsget
Payments API
Cancel a Paymentpost
Payment Statusget
Create Paymentpost
Merchants API
Fetch Merchant Deposit Transactionsget
Fetch Merchant Depositsget
Fetch a Merchant's Brandget
Fetch a Merchantget
List merchants that are accessible by the logged in userget

201CREATED

400Bad Request

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error