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)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
CreateRefundLinkRequest createRefundLinkRequest =
new CreateRefundLinkRequest()
.businessInfo(
new RefundLinkBusinessInfo()
.transactionId("aff0e1cb-15b2-4e1f-9b9d-a9133715986f")
.amount("0.0025")
.refundSource(RefundType.MERCHANT));
try {
Link result = apiInstance.createRefundLink(createRefundLinkRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#createRefundLink");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
createRefundLinkRequest := *coboWaas2.NewCreateRefundLinkRequest(*coboWaas2.NewRefundLinkBusinessInfo("aff0e1cb-15b2-4e1f-9b9d-a9133715986f", "0.0025", coboWaas2.RefundType("Merchant")))
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.CreateRefundLink(ctx).
CreateRefundLinkRequest(createRefundLinkRequest).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreateRefundLink``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRefundLink`: Link
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreateRefundLink`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const opts = {
CreateRefundLinkRequest:
CoboWaas2.CreateRefundLinkRequest.constructFromObject({
business_info: {
transaction_id: "aff0e1cb-15b2-4e1f-9b9d-a9133715986f",
amount: "0.0025",
refund_source: "Merchant",
},
}),
};
apiInstance.createRefundLink(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"url": "https://payment-link.dev.cobo.com/payment",
"token": "01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}Create refund link
This operation creates a link that points to a Cobo-hosted refund page. The user can submit their desired refund address on the page.
Once the address is submitted, Cobo will automatically create a refund order and initiate the refund process according to your configuration.
For details, see Create refund link.
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)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
CreateRefundLinkRequest createRefundLinkRequest =
new CreateRefundLinkRequest()
.businessInfo(
new RefundLinkBusinessInfo()
.transactionId("aff0e1cb-15b2-4e1f-9b9d-a9133715986f")
.amount("0.0025")
.refundSource(RefundType.MERCHANT));
try {
Link result = apiInstance.createRefundLink(createRefundLinkRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#createRefundLink");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
createRefundLinkRequest := *coboWaas2.NewCreateRefundLinkRequest(*coboWaas2.NewRefundLinkBusinessInfo("aff0e1cb-15b2-4e1f-9b9d-a9133715986f", "0.0025", coboWaas2.RefundType("Merchant")))
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.CreateRefundLink(ctx).
CreateRefundLinkRequest(createRefundLinkRequest).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreateRefundLink``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRefundLink`: Link
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreateRefundLink`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const opts = {
CreateRefundLinkRequest:
CoboWaas2.CreateRefundLinkRequest.constructFromObject({
business_info: {
transaction_id: "aff0e1cb-15b2-4e1f-9b9d-a9133715986f",
amount: "0.0025",
refund_source: "Merchant",
},
}),
};
apiInstance.createRefundLink(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
{
"url": "https://payment-link.dev.cobo.com/payment",
"token": "01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}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)
// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Select the development environment. To use the production environment, replace `Env.DEV` with
// `Env.PROD
defaultClient.setEnv(Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
PaymentApi apiInstance = new PaymentApi();
CreateRefundLinkRequest createRefundLinkRequest =
new CreateRefundLinkRequest()
.businessInfo(
new RefundLinkBusinessInfo()
.transactionId("aff0e1cb-15b2-4e1f-9b9d-a9133715986f")
.amount("0.0025")
.refundSource(RefundType.MERCHANT));
try {
Link result = apiInstance.createRefundLink(createRefundLinkRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentApi#createRefundLink");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
package main
import (
"context"
"fmt"
coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
"os"
)
func main() {
createRefundLinkRequest := *coboWaas2.NewCreateRefundLinkRequest(*coboWaas2.NewRefundLinkBusinessInfo("aff0e1cb-15b2-4e1f-9b9d-a9133715986f", "0.0025", coboWaas2.RefundType("Merchant")))
configuration := coboWaas2.NewConfiguration()
// Initialize the API client
apiClient := coboWaas2.NewAPIClient(configuration)
ctx := context.Background()
// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
// Replace `<YOUR_PRIVATE_KEY>` with your private key
ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
Secret: "<YOUR_PRIVATE_KEY>",
})
resp, r, err := apiClient.PaymentAPI.CreateRefundLink(ctx).
CreateRefundLinkRequest(createRefundLinkRequest).
Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PaymentAPI.CreateRefundLink``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRefundLink`: Link
fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.CreateRefundLink`: %v\n", resp)
}
const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const opts = {
CreateRefundLinkRequest:
CoboWaas2.CreateRefundLinkRequest.constructFromObject({
business_info: {
transaction_id: "aff0e1cb-15b2-4e1f-9b9d-a9133715986f",
amount: "0.0025",
refund_source: "Merchant",
},
}),
};
apiInstance.createRefundLink(opts).then(
(data) => {
console.log("API called successfully. Returned data: " + data);
},
(error) => {
console.error(error);
},
);
Authorizations
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
The request body to create a refund link.
Response
Link created successfully.
The base URL of the page. This URL should be combined with the token parameter to form the complete link.
"https://payment-link.dev.cobo.com/payment"
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]
"01EJ5QW8KtSBesqnRZsmadPgihYf754OnVnNhimKKBi6QQO5PNyr9EXPyFRJGGOF"
