Set SubLedger Callback Urls

POST

/core/callback-url/{clientId}

This API sets the callback URLs for subledger operations for a given client. The client is identified by the clientId provided as a path variable. The request body includes the callback URLs for normal, utility, and invoice operations. The response returns the updated callback URL settings.

Path Parameters

Field Name	Type	Required	Description
clientId	string	TRUE	The unique identifier of the client/merchant.

Request Body

Field Name	Type	Required	Description
normal	string	FALSE	The callback URL for normal subledger transactions.
utility	string	FALSE	The callback URL for utility subledger transactions.
invoice	string	FALSE	The callback URL for invoice subledger transactions.

Response Body

Field Name	Type	Description
normal	string	The updated callback URL for normal transactions, or null if not set.
utility	string	The updated callback URL for utility transactions, or null if not set.
invoice	string	The updated callback URL for invoice transactions, or null if not set.

Request

Path Params

Body Params application/json

Example

{
    "normal": "normal callback url",
    "utility": "utility callback url",
    "invoice": "invoice callback url"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/core/callback-url/2976' \
--header 'Content-Type: application/json' \
--data-raw '{
    "normal": "normal callback url",
    "utility": "utility callback url",
    "invoice": "invoice callback url"
}'

Responses

🟢200Set SubLedger Callback Urls

application/json

Body

Example

{
    "normal": null,
    "utility": "utility callback url",
    "invoice": null
}

Modified at 2025-03-17 22:27:42

Get SubLedger Callback Urls

Get Collection Accounts