Class Transactions

Hierarchy

APIResource
- Transactions

Index

Constructors

Properties

Methods

get getDeprecated list listDeprecated refund

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

get

get(
    merchantCode: string,
    query?: GetTransactionV2_1QueryParams,
    options?: RequestOptions,
): APIPromise<TransactionFull, ErrorBody | Problem>
Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and one of following parameters is required:
- id
- internal_id
- transaction_code
- foreign_transaction_id
- client_transaction_id
Parameters
- merchantCode: string
- Optionalquery: GetTransactionV2_1QueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<TransactionFull, ErrorBody | Problem>
- Defined in src/resources/transactions/index.ts:113

getDeprecated

getDeprecated(
query?: GetTransactionQueryParams,
options?: RequestOptions,
): APIPromise<TransactionFull, ErrorBody | Problem>
Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and one of following parameters is required:
- id
- internal_id
- transaction_code
- foreign_transaction_id
- client_transaction_id
Parameters
- Optionalquery: GetTransactionQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<TransactionFull, ErrorBody | Problem>
- Defined in src/resources/transactions/index.ts:135

list

list(
    merchantCode: string,
    query?: ListTransactionsV2_1QueryParams,
    options?: RequestOptions,
): APIPromise<ListTransactionsV2_1Response, ErrorBody | Problem>
Lists detailed history of all transactions associated with the merchant profile.
Parameters
- merchantCode: string
- Optionalquery: ListTransactionsV2_1QueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<ListTransactionsV2_1Response, ErrorBody | Problem>
- Defined in src/resources/transactions/index.ts:149

listDeprecated

listDeprecated(
query?: ListTransactionsQueryParams,
options?: RequestOptions,
): APIPromise<ListTransactionsResponse, ErrorBody | Problem>
Lists detailed history of all transactions associated with the merchant profile.
Parameters
- Optionalquery: ListTransactionsQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<ListTransactionsResponse, ErrorBody | Problem>
- Defined in src/resources/transactions/index.ts:164

refund

refund(
    txnId: string,
    body?: RefundTransactionParams,
    options?: RequestOptions,
): APIPromise<void, ErrorBody>
Refunds an identified transaction either in full or partially.
Parameters
- txnId: string
- Optionalbody: RefundTransactionParams
- Optionaloptions: RequestOptions
Returns APIPromise<void, ErrorBody>
- Defined in src/resources/transactions/index.ts:91