Skip to content

Latest commit

 

History

History
154 lines (114 loc) · 5.81 KB

refunds.md

File metadata and controls

154 lines (114 loc) · 5.81 KB
Raw

Refunds

RefundsApi refundsApi = client.getRefundsApi();

Class Name

RefundsApi

Methods

List Payment Refunds

Retrieves a list of refunds for the account making the request.

Results are eventually consistent, and new refunds or changes to refunds might take several seconds to appear.

The maximum results per page is 100.

CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(
    final String beginTime,
    final String endTime,
    final String sortOrder,
    final String cursor,
    final String locationId,
    final String status,
    final String sourceType,
    final Integer limit)

Parameters

Parameter Type Tags Description
beginTime String Query, Optional Indicates the start of the time range to retrieve each PaymentRefund for, in RFC 3339
format. The range is determined using the created_at field for each PaymentRefund.

Default: The current time minus one year.
endTime String Query, Optional Indicates the end of the time range to retrieve each PaymentRefund for, in RFC 3339
format. The range is determined using the created_at field for each PaymentRefund.

Default: The current time.
sortOrder String Query, Optional The order in which results are listed by PaymentRefund.created_at:

- ASC - Oldest to newest.
- DESC - Newest to oldest (default).
cursor String Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.

For more information, see Pagination.
locationId String Query, Optional Limit results to the location supplied. By default, results are returned
for all locations associated with the seller.
status String Query, Optional If provided, only refunds with the given status are returned.
For a list of refund status values, see PaymentRefund.

Default: If omitted, refunds are returned regardless of their status.
sourceType String Query, Optional If provided, only returns refunds whose payments have the indicated source type.
Current values include CARD, BANK_ACCOUNT, WALLET, CASH, and EXTERNAL.
For information about these payment source types, see
Take Payments.

Default: If omitted, refunds are returned regardless of the source type.
limit Integer Query, Optional The maximum number of results to be returned in a single page.

It is possible to receive fewer results than the specified limit on a given page.

If the supplied value is greater than 100, no more than 100 results are returned.

Default: 100

Response Type

ListPaymentRefundsResponse

Example Usage

refundsApi.listPaymentRefundsAsync(null, null, null, null, null, null, null, null).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Refund Payment

Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more information, see Refund Payment.

CompletableFuture<RefundPaymentResponse> refundPaymentAsync(
    final RefundPaymentRequest body)

Parameters

Parameter Type Tags Description
body RefundPaymentRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

RefundPaymentResponse

Example Usage

RefundPaymentRequest body = new RefundPaymentRequest.Builder(
    "9b7f2dcf-49da-4411-b23e-a2d6af21333a",
    new Money.Builder()
        .amount(1000L)
        .currency("USD")
        .build()
)
.appFeeMoney(new Money.Builder()
        .amount(10L)
        .currency("USD")
        .build())
.paymentId("R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY")
.reason("Example")
.build();

refundsApi.refundPaymentAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Get Payment Refund

Retrieves a specific refund using the refund_id.

CompletableFuture<GetPaymentRefundResponse> getPaymentRefundAsync(
    final String refundId)

Parameters

Parameter Type Tags Description
refundId String Template, Required The unique ID for the desired PaymentRefund.

Response Type

GetPaymentRefundResponse

Example Usage

String refundId = "refund_id4";

refundsApi.getPaymentRefundAsync(refundId).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});