Skip to main content
POST
/
payments
/
links
/
refunds
import cobo_waas2
from cobo_waas2.models.create_refund_link_request import CreateRefundLinkRequest
from cobo_waas2.models.link import Link
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_refund_link_request = cobo_waas2.CreateRefundLinkRequest(
        business_info=cobo_waas2.RefundLinkBusinessInfo(
            transaction_id="aff0e1cb-15b2-4e1f-9b9d-a9133715986f",
            amount="0.0025",
            refund_source="Merchant",
        )
    )

    try:
        # Create refund link
        api_response = api_instance.create_refund_link(
            create_refund_link_request=create_refund_link_request
        )
        print("The response of PaymentApi->create_refund_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_refund_link: %s\n" % e)

{
  "url": "https://payment-link.dev.cobo.com/payment",
  "token": "01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF"
}
import cobo_waas2
from cobo_waas2.models.create_refund_link_request import CreateRefundLinkRequest
from cobo_waas2.models.link import Link
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_refund_link_request = cobo_waas2.CreateRefundLinkRequest(
        business_info=cobo_waas2.RefundLinkBusinessInfo(
            transaction_id="aff0e1cb-15b2-4e1f-9b9d-a9133715986f",
            amount="0.0025",
            refund_source="Merchant",
        )
    )

    try:
        # Create refund link
        api_response = api_instance.create_refund_link(
            create_refund_link_request=create_refund_link_request
        )
        print("The response of PaymentApi->create_refund_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_refund_link: %s\n" % e)

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
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"