Happy Business Starts Here


Payment Method API object formats REST

There are two rest APIs returning the same underlying objects, but not in the same format at all. This is tricky to work with and has the likelihood of introducing bugs in our code.


Is there a route that I'm missing, or an undocumented route for payment methods, where I can do a list operation, and a get operation, and have the same underlying object be in equivalent formats (same keys and same capitalization)?


https://www.zuora.com/developer/api-reference/#operation/GET_PaymentMethods (really just credit cards, not ACH)


https://www.zuora.com/developer/api-reference/#operation/Object_GETPaymentMethod (ACH or credit cards and in a different object format)

Zuora Staff

Re: Payment Method API object formats REST

Hi @ruffrey,


Thanks for bringing this to our attention, I have flagged this inconsistancy with our Documentation team now so that the Developer resource is updated.


Our recommendation for you would be to use the second endpoint as this covers all payment methods.

If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √


Re: Payment Method API object formats REST

Thank you. Just to clarify:


The second endpoint is for getting a single object, while the first invoice is for getting a list of credit cards. They are in two different field formats, too.


I would have expected a way to list payment methods that includes ACH methods, which does not appear to exist.


Re: Payment Method API object formats REST

Just following up - 1) is there any chance of getting a more consistent object format, and 2) is there a plan to add REST APIs for ACH?

Savvy Scholar

Re: Payment Method API object formats REST

I would like to second this request, and underscore our desire for CORS REST support for ACH payment methods.