Class BetaReferralCustomerService

java.lang.Object

com.easypost.service.BetaReferralCustomerService

public class BetaReferralCustomerService
extends Object

Method Summary

Modifier and Type	Method	Description
PaymentMethodObject	addPaymentMethod(String stripeCustomerId, String paymentMethodReference)	Add Stripe payment method to referral customer.
PaymentMethodObject	addPaymentMethod(String stripeCustomerId, String paymentMethodReference, PaymentMethod.Priority primaryOrSecondary)	Add Stripe payment method to referral customer.
ClientSecret	createBankAccountClientSecret()	Creates a client secret to use with Stripe when adding a bank account.
ClientSecret	createBankAccountClientSecret(String returnUrl)	Creates a client secret to use with Stripe when adding a bank account.
ClientSecret	createCreditCardClientSecret()	Creates a client secret to use with Stripe when adding a credit card.
BetaPaymentRefund	refundByAmount(int refundAmount)	Refund by amount for a recent payment.
BetaPaymentRefund	refundByPaymentLog(String paymentLogId)	Refund a payment by a payment log ID.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

addPaymentMethod

public PaymentMethodObject addPaymentMethod(String stripeCustomerId,
 String paymentMethodReference)
                                     throws EasyPostException

Add Stripe payment method to referral customer.

Parameters:

stripeCustomerId - ID of the Stripe account.

paymentMethodReference - Reference of Stripe payment method.

Returns:

PaymentMethodObject object.

Throws:

EasyPostException - When the request fails.

addPaymentMethod

public PaymentMethodObject addPaymentMethod(String stripeCustomerId,
 String paymentMethodReference,
 PaymentMethod.Priority primaryOrSecondary)
                                     throws EasyPostException

Add Stripe payment method to referral customer.

Parameters:

stripeCustomerId - ID of the Stripe account.

paymentMethodReference - Reference of Stripe payment method.

primaryOrSecondary - Primary or secondary of this payment method.

Returns:

PaymentMethodObject object.

Throws:

EasyPostException - When the request fails.

refundByAmount

public BetaPaymentRefund refundByAmount(int refundAmount)
                                 throws EasyPostException

Refund by amount for a recent payment.

Parameters:

refundAmount - Amount to be refunded by cents.

Returns:

BetaPaymentRefund object.

Throws:

EasyPostException - When the request fails.

refundByPaymentLog

public BetaPaymentRefund refundByPaymentLog(String paymentLogId)
                                     throws EasyPostException

Refund a payment by a payment log ID.

Parameters:

paymentLogId - ID of the payment log.

Returns:

BetaPaymentRefund object.

Throws:

EasyPostException - When the request fails.

createCreditCardClientSecret

public ClientSecret createCreditCardClientSecret()
                                          throws EasyPostException

Creates a client secret to use with Stripe when adding a credit card.

Returns:

ClientSecret containing the client secret.

Throws:

EasyPostException - When the request fails.

createBankAccountClientSecret

public ClientSecret createBankAccountClientSecret()
                                           throws EasyPostException

Creates a client secret to use with Stripe when adding a bank account.

Returns:

ClientSecret containing the client secret.

Throws:

EasyPostException - When the request fails.

createBankAccountClientSecret

public ClientSecret createBankAccountClientSecret(String returnUrl)
                                           throws EasyPostException

Creates a client secret to use with Stripe when adding a bank account.

Parameters:

returnUrl - Optional return URL for the bank account setup.

Returns:

ClientSecret containing the client secret.

Throws:

EasyPostException - When the request fails.