payment-api.md

Payment API

A payment is the money that customers send to pay for billing documents related to their subscriptions.

The Payment object holds all of the information about an individual payment, including the payment amount, to which billing documents the payment was applied to, and so on.

Class Name

PaymentAPI

Methods

• Create payment
• Get payment
• Update payment

Create Payment

Creates a new payment.

Payment payment = zuoraClient.payments().create(params);

Parameters

Parameter	Type	Tags	Description
params	PaymentCreateRequest	Required	Payment create request.

Response Type

Payment

Example

PaymentCreateRequest params = PaymentCreateRequest.builder()
        .amount(10.0d)
        .account("account_id8")
        .authorisationCode("7368")
        .currency("USD")
        .external(true)
        .build();

Payment payment = zuoraClient.payments().create(params);

Get Payment

Retrieves a payment by ID.

Payment payment = zuoraClient.payments().get(id);

Parameters

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

Response Type

Payment

Example

Payment payment = zuoraClient.payments().get(id);

Update Payment

Payment payment = payment.update();

Example

String Payment_ID = "payment_id8";
Payment payment = zuoraClient.payments().get(PAYMENT_ID);

payment.setName("New Name");
payment.update();