Payment
Types
Link copied to clipboard
interface WithRawResponse
A view of PaymentServiceAsync that provides access to raw HTTP responses for each method.
Functions
Link copied to clipboard
abstract suspend fun create(params: PaymentCreateParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentCreateResponse
Initiates a payment between a financial account and an external bank account.
Link copied to clipboard
abstract suspend fun list(params: PaymentListParams = PaymentListParams.none(), requestOptions: RequestOptions = RequestOptions.none()): PaymentListPageAsync
List all the payments for the provided search criteria.
Link copied to clipboard
abstract suspend fun retrieve(params: PaymentRetrieveParams, requestOptions: RequestOptions = RequestOptions.none()): Payment
open suspend fun retrieve(paymentToken: String, params: PaymentRetrieveParams = PaymentRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Payment
Get the payment by token.
Link copied to clipboard
abstract suspend fun retry(params: PaymentRetryParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentRetryResponse
open suspend fun retry(paymentToken: String, params: PaymentRetryParams = PaymentRetryParams.none(), requestOptions: RequestOptions = RequestOptions.none()): PaymentRetryResponse
Retry an origination which has been returned.
Link copied to clipboard
abstract suspend fun simulateAction(params: PaymentSimulateActionParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentSimulateActionResponse
open suspend fun simulateAction(paymentToken: String, params: PaymentSimulateActionParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentSimulateActionResponse
Simulate payment lifecycle event
Link copied to clipboard
abstract suspend fun simulateReceipt(params: PaymentSimulateReceiptParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentSimulateReceiptResponse
Simulates a receipt of a Payment.
Link copied to clipboard
abstract suspend fun simulateRelease(params: PaymentSimulateReleaseParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentSimulateReleaseResponse
Simulates a release of a Payment.
Link copied to clipboard
abstract suspend fun simulateReturn(params: PaymentSimulateReturnParams, requestOptions: RequestOptions = RequestOptions.none()): PaymentSimulateReturnResponse
Simulates a return of a Payment.
Link copied to clipboard
Returns a view of this service with the given option modifications applied.
Link copied to clipboard
Returns a view of this service that provides access to raw HTTP responses for each method.