Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure a custom payment method type

Learn how to configure, update, and publish a custom payment method type using API operations.

  1. Create a draft version of your custom payment method type by using the Create a draft custom payment method type API operation. Revision number 1 is assigned to this version.
  2. If you need to update the latest draft version of your custom payment method type, use the Update a custom payment method type API operation. Note that in the request body, you need to provide all the fields that define this custom payment method type including fields to be updated and the unchanged fields.
  3. When your latest draft revision is ready for publishing, publish the latest draft revision of your custom payment method type by using the Publish a custom payment method type API operation.

After a revision is published, you can still update your custom payment method type. When you update a published revision for the first time, the revision number is increased by 1. You need to publish your latest revision again before your updated custom payment method type goes live.

If you want to enable the Asynchronous Payment Statuses feature in handling transactions with your custom payment method, specify isSupportAsyncPayment as true when defining or updating the payment method type. You also need to complete tasks described in Enable the Asynchronous Payment Statuses feature.