Constructor Detail

Method Detail

• withRawResponse

   abstract PaymentService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract PaymentService withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• create

   PaymentCreateResponse create(PaymentCreateParams params)

  Initiates a payment between a financial account and an external bank account.

• create

   abstract PaymentCreateResponse create(PaymentCreateParams params, RequestOptions requestOptions)

• retrieve

   Payment retrieve(String paymentToken)

  Get the payment by token.

• retrieve

   Payment retrieve(String paymentToken, PaymentRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Payment retrieve(String paymentToken, PaymentRetrieveParams params)

• retrieve

   abstract Payment retrieve(PaymentRetrieveParams params, RequestOptions requestOptions)

• retrieve

   Payment retrieve(PaymentRetrieveParams params)

• retrieve

   Payment retrieve(String paymentToken, RequestOptions requestOptions)

• list

   PaymentListPage list()

  List all the payments for the provided search criteria.

• list

   abstract PaymentListPage list(PaymentListParams params, RequestOptions requestOptions)

• list

   PaymentListPage list(PaymentListParams params)

• list

   PaymentListPage list(RequestOptions requestOptions)

• retry

   PaymentRetryResponse retry(String paymentToken)

  Retry an origination which has been returned.

• retry

   PaymentRetryResponse retry(String paymentToken, PaymentRetryParams params, RequestOptions requestOptions)

• retry

   PaymentRetryResponse retry(String paymentToken, PaymentRetryParams params)

• retry

   abstract PaymentRetryResponse retry(PaymentRetryParams params, RequestOptions requestOptions)

• retry

   PaymentRetryResponse retry(PaymentRetryParams params)

• retry

   PaymentRetryResponse retry(String paymentToken, RequestOptions requestOptions)

• return_

   PaymentReturnResponse return_(String paymentToken, PaymentReturnParams params)

  Return an ACH payment with a specified return reason code. Returns must be initiated within the time window specified by NACHA rules for each return code (typically 2 banking days for most codes, 60 calendar days for unauthorized debits). For a complete list of return codes and their meanings, see the ACH Return Reasons documentation.

  Note:

  • This endpoint does not modify the state of the financial account associated with the payment. If you would like to change the account state, use the Update financial account status endpoint.

  • By default this endpoint is not enabled for your account. Please contact your implementations manager to enable this feature.

• return_

   PaymentReturnResponse return_(String paymentToken, PaymentReturnParams params, RequestOptions requestOptions)

• return_

   PaymentReturnResponse return_(PaymentReturnParams params)

• return_

   abstract PaymentReturnResponse return_(PaymentReturnParams params, RequestOptions requestOptions)

• simulateAction

   PaymentSimulateActionResponse simulateAction(String paymentToken, PaymentSimulateActionParams params)

  Simulate payment lifecycle event

• simulateAction

   PaymentSimulateActionResponse simulateAction(String paymentToken, PaymentSimulateActionParams params, RequestOptions requestOptions)

• simulateAction

   PaymentSimulateActionResponse simulateAction(PaymentSimulateActionParams params)

• simulateAction

   abstract PaymentSimulateActionResponse simulateAction(PaymentSimulateActionParams params, RequestOptions requestOptions)

• simulateReceipt

   PaymentSimulateReceiptResponse simulateReceipt(PaymentSimulateReceiptParams params)

  Simulates a receipt of a Payment.

• simulateReceipt

   abstract PaymentSimulateReceiptResponse simulateReceipt(PaymentSimulateReceiptParams params, RequestOptions requestOptions)

• simulateRelease

   PaymentSimulateReleaseResponse simulateRelease(PaymentSimulateReleaseParams params)

  Simulates a release of a Payment.

• simulateRelease

   abstract PaymentSimulateReleaseResponse simulateRelease(PaymentSimulateReleaseParams params, RequestOptions requestOptions)

• simulateReturn

   PaymentSimulateReturnResponse simulateReturn(PaymentSimulateReturnParams params)

  Simulates a return of a Payment.

• simulateReturn

   abstract PaymentSimulateReturnResponse simulateReturn(PaymentSimulateReturnParams params, RequestOptions requestOptions)