Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 1.95 KB

payment-method-api.md

File metadata and controls

84 lines (52 loc) · 1.95 KB

Payment Method API

PaymentMethod objects represent your customer's payment instruments and must be associated with an Account object. They can be used to collect payments and stored for future payments.

Class Name

PaymentMethodAPI

Methods

Create Payment Method

PaymentMethod paymentMethod = zuoraClient.paymentMethods().create(params);

Parameters

Parameter Type Tags Description
params PaymentMethodCreateRequest Required A payment method create request.

Response Type

PaymentMethod

Example

PaymentMethod paymentMethod = zuoraClient.paymentMethods().create(params);

Get Payment Method

PaymentMethod paymentMethod = zuoraClient.paymentMethods().get(id);

Parameters

Parameter Type Tags Description
id String Required The unique identifier of a payment method.

Response Type

PaymentMethod

Example

String PAYMENT_METHOD_ID = "2c92c0f872c68b450172dad9c61e436b";

PaymentMethod paymentMethod = zuoraClient.paymentMethods().get(PAYMENT_METHOD_ID);

Delete Payment Method

PaymentMethod paymentMethod = zuoraClient.paymentMethods().delete(id);

Parameters

Parameter Type Tags Description
id String Required The unique identifier of a payment method.

Response Type

PaymentMethod

Example

String PAYMENT_METHOD_ID = "2c92c0f872c68b450172dad9c61e436b";

PaymentMethod paymentMethod = zuoraClient.paymentMethods().delete(PAYMENT_METHOD_ID);