Skip to content

Latest commit

 

History

History
157 lines (118 loc) · 5.36 KB

refunds.md

File metadata and controls

157 lines (118 loc) · 5.36 KB
Raw

Refunds

IRefundsApi refundsApi = client.RefundsApi;

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.

ListPaymentRefundsAsync(
    string beginTime = null,
    string endTime = null,
    string sortOrder = null,
    string cursor = null,
    string locationId = null,
    string status = null,
    string sourceType = null,
    int? limit = null)

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 int? 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

Task<Models.ListPaymentRefundsResponse>

Example Usage

try
{
    ListPaymentRefundsResponse result = await refundsApi.ListPaymentRefundsAsync();
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

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.

RefundPaymentAsync(
    Models.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

Task<Models.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();

try
{
    RefundPaymentResponse result = await refundsApi.RefundPaymentAsync(body);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}

Get Payment Refund

Retrieves a specific refund using the refund_id.

GetPaymentRefundAsync(
    string refundId)

Parameters

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

Response Type

Task<Models.GetPaymentRefundResponse>

Example Usage

string refundId = "refund_id4";
try
{
    GetPaymentRefundResponse result = await refundsApi.GetPaymentRefundAsync(refundId);
}
catch (ApiException e)
{
    // TODO: Handle exception here
    Console.WriteLine(e.Message);
}