Skip to main content
POST

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to create a refund link.

business_info
object
required
request_id
string

The request ID that is used to track a refund link request. The request ID is provided by you and must be unique.

Maximum string length: 128
Example:

"123e4567-e89b-12d3-a456-426614174004"

display_info
object

Response

Link created successfully.

url
string<uri>
required

The base URL of the page. This URL should be combined with the token parameter to form the complete link.

Example:

"https://payment-link.dev.cobo.com/payment"

token
string
required

The token appended to the URL as a query parameter. This token identifies and authenticates a specific payment or refund session.

The complete link should be constructed as: [url]?token=[token]

Example:

"01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF"