Skip to content

Latest commit

 

History

History
170 lines (129 loc) · 6.12 KB

refunds.md

File metadata and controls

170 lines (129 loc) · 6.12 KB
Raw

Refunds

const 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.

async listPaymentRefunds(
  beginTime?: string,
  endTime?: string,
  sortOrder?: string,
  cursor?: string,
  locationId?: string,
  status?: string,
  sourceType?: string,
  limit?: number,
  requestOptions?: RequestOptions
): Promise<ApiResponse<ListPaymentRefundsResponse>>

Parameters

Parameter Type Tags Description
beginTime string | undefined Query, Optional The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

Default: The current time minus one year.
endTime string | undefined Query, Optional The timestamp for the end of the requested reporting period, in RFC 3339 format.

Default: The current time.
sortOrder string | undefined Query, Optional The order in which results are listed:

- ASC - Oldest to newest.
- DESC - Newest to oldest (default).
cursor string | undefined 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 | undefined Query, Optional Limit results to the location supplied. By default, results are returned
for all locations associated with the seller.
status string | undefined 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 | undefined 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 number | undefined 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
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

ListPaymentRefundsResponse

Example Usage

try {
  const { result, ...httpResponse } = await refundsApi.listPaymentRefunds();
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

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.

async refundPayment(
  body: RefundPaymentRequest,
  requestOptions?: RequestOptions
): Promise<ApiResponse<RefundPaymentResponse>>

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.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

RefundPaymentResponse

Example Usage

const contentType = null;
const bodyAmountMoney: Money = {};
bodyAmountMoney.amount = BigInt(1000);
bodyAmountMoney.currency = 'USD';

const bodyAppFeeMoney: Money = {};
bodyAppFeeMoney.amount = BigInt(10);
bodyAppFeeMoney.currency = 'USD';

const body: RefundPaymentRequest = {
  idempotencyKey: '9b7f2dcf-49da-4411-b23e-a2d6af21333a',
  amountMoney: bodyAmountMoney,
};
body.appFeeMoney = bodyAppFeeMoney;
body.paymentId = 'R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY';
body.reason = 'Example';

try {
  const { result, ...httpResponse } = await refundsApi.refundPayment(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Get Payment Refund

Retrieves a specific refund using the refund_id.

async getPaymentRefund(
  refundId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetPaymentRefundResponse>>

Parameters

Parameter Type Tags Description
refundId string Template, Required The unique ID for the desired PaymentRefund.
requestOptions RequestOptions | undefined Optional Pass additional request options.

Response Type

GetPaymentRefundResponse

Example Usage

const refundId = 'refund_id4';
try {
  const { result, ...httpResponse } = await refundsApi.getPaymentRefund(refundId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}