Payment API JavaScript usage

To call the Commerce REST endpoints, initialize the Adobe Commerce Client:

const { getAdobeCommerceClient } = require("../lib/adobe-commerce");
const commerceClient = await getAdobeCommerceClient(process.env);
Copied to your clipboard
const { getAdobeCommerceClient } = require("../lib/adobe-commerce");
const commerceClient = await getAdobeCommerceClient(process.env);

Create a new payment method

createOopePaymentMethod creates a new out-of-process payment method with the necessary details such as code, title, and configuration.

Check the API reference for more details.

Example usage

try {
  const createResponse = await commerceClient.createOopePaymentMethod({
    code: "method-1",
    title: "Method 1",
    description: "Description for Method 1",
    active: true,
    backend_integration_url: "https://example.com",
    stores: ["store-1", "store-2"],
    order_status: "processing",
    countries: ["US", "ES"],
    currencies: ["USD", "EUR"],
    custom_config: [{ key: "key1", value: "value1" }],
  });

  if (!createResponse.success) {
    return errorResponse(
      createResponse.statusCode,
      "Failed to create payment method",
    );
  }

  console.log("Created payment method:", createResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while creating payment method",
  );
}
Copied to your clipboard
try {
  const createResponse = await commerceClient.createOopePaymentMethod({
    code: "method-1",
    title: "Method 1",
    description: "Description for Method 1",
    active: true,
    backend_integration_url: "https://example.com",
    stores: ["store-1", "store-2"],
    order_status: "processing",
    countries: ["US", "ES"],
    currencies: ["USD", "EUR"],
    custom_config: [{ key: "key1", value: "value1" }],
  });

  if (!createResponse.success) {
    return errorResponse(
      createResponse.statusCode,
      "Failed to create payment method",
    );
  }

  console.log("Created payment method:", createResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while creating payment method",
  );
}

List all payment methods

getOopePaymentMethods retrieves a list of all out-of-process payment methods in the Adobe Commerce instance.

Check the API reference for more details.

Example usage

try {
  const listResponse = await commerceClient.getOopePaymentMethods();
  if (!listResponse.success) {
    return errorResponse(
      listResponse.statusCode,
      "Failed to list payment methods",
    );
  }
  console.log("List of payment methods:", listResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while listing payment methods",
  );
}
Copied to your clipboard
try {
  const listResponse = await commerceClient.getOopePaymentMethods();
  if (!listResponse.success) {
    return errorResponse(
      listResponse.statusCode,
      "Failed to list payment methods",
    );
  }
  console.log("List of payment methods:", listResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while listing payment methods",
  );
}

Get an OOPE payment method by code

getOopePaymentMethod retrieves one out-of-process payment method by code from the Adobe Commerce instance.

Check the API reference for more details.

Example usage

try {
  const getResponse = await commerceClient.getOopePaymentMethod("method-1");
  if (!getResponse.success) {
    return errorResponse(
      getResponse.statusCode,
      "Failed to retrieve payment method",
    );
  }
  console.log("Retrieved payment method details:", getResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while retrieving payment method",
  );
}
Copied to your clipboard
try {
  const getResponse = await commerceClient.getOopePaymentMethod("method-1");
  if (!getResponse.success) {
    return errorResponse(
      getResponse.statusCode,
      "Failed to retrieve payment method",
    );
  }
  console.log("Retrieved payment method details:", getResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Error occurred while retrieving payment method",
  );
}

Retrieve an order by masked cart ID

getOrderByMaskedCartId retrieves order details from the Adobe Commerce instance using maskedCartID. This is typically used when the app builder application receives a webhook or event from the payment gateway.

This method uses the Adobe Commerce API order search criteria.

Payload parameters:

Parameter	Type	Description
`maskedCartId`	String	The cart ID from the payment method webhook or event.

Example usage:

try {
  const orderResponse =
    await commerceClient.getOrderByMaskedCartId(maskedCartId);
  if (!orderResponse.success) {
    const errMsg =
      orderResponse.statusCode === HTTP_NOT_FOUND
        ? "Order not found for the given maskedCartId."
        : "Unexpected error getting order by maskedCartId";
    return errorResponse(orderResponse.statusCode, errMsg);
  }
  console.log("Order details:", orderResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Failed to fetch order due to an unexpected error",
  );
}
Copied to your clipboard
try {
  const orderResponse =
    await commerceClient.getOrderByMaskedCartId(maskedCartId);
  if (!orderResponse.success) {
    const errMsg =
      orderResponse.statusCode === HTTP_NOT_FOUND
        ? "Order not found for the given maskedCartId."
        : "Unexpected error getting order by maskedCartId";
    return errorResponse(orderResponse.statusCode, errMsg);
  }
  console.log("Order details:", orderResponse.message);
} catch (error) {
  return errorResponse(
    HTTP_INTERNAL_ERROR,
    "Failed to fetch order due to an unexpected error",
  );
}

Payment use cases

Payment API reference

Last updated 5/20/2025

Was this helpful?

Yes

Payment API JavaScript usage

Create a new payment method.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

List all payment methods

Get an OOPE payment method by code

Retrieve an order by masked cart ID

Create a new payment method