Class Receipts

API resource for the Receipts endpoints.

The Receipts model obtains receipt-like details for specific transactions.

Hierarchy

APIResource
- Receipts

Index

Constructors

Properties

Methods

_transformQueryParams get getWithResponse

Constructors

constructor

new Receipts(client: SumUp): Receipts
Parameters
- client: SumUp
Returns Receipts
Inherited from APIResource.constructor
- Defined in src/core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

`Protected`_transformQueryParams

_transformQueryParams(
query: QueryParams | undefined,
names: Record<string, string>,
): QueryParams | undefined
Parameters
- query: QueryParams | undefined
- names: Record<string, string>
Returns QueryParams | undefined
Inherited from APIResource._transformQueryParams
- Defined in src/core.ts:12

get

get(
    transactionId: string,
    query: GetReceiptQueryParams,
    options?: RequestOptions,
): Promise<Receipt>
Retrieves receipt specific data for a transaction.
Parameters
- transactionId: string
- query: GetReceiptQueryParams
- Optionaloptions: RequestOptions
Returns Promise<Receipt>
- Defined in src/resources/receipts/index.ts:23

getWithResponse

getWithResponse(
    transactionId: string,
    query: GetReceiptQueryParams,
    options?: RequestOptions,
): Promise<WithResponse<Receipt>>
Parameters
- transactionId: string
- query: GetReceiptQueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Receipt>>
- Defined in src/resources/receipts/index.ts:35