import {ApiTransactions} from 'ingresse-sdk/src/apis/api.transactions.js'

public class | source

ApiTransactions

Extends:

RequestHandler → ApiTransactions

Ingresse Transactions API

Method Summary

Public Methods
public	cancel(id: string, query: object): Promise Cancel a pending transaction
public	capture(id: string, query: object): Promise Capture an authorized transaction
public	chargeback(id: string, type: string, body: string, query: object): Promise Include chargeback transaction
public	getById(id: string, query: object): Promise Get a transaction by ID
public	getDecisionReasons(query: object): Promise Get decision reason
public	getList(query: object): Promise Get a list of transactions
public	getPasskeysReport(eventId: number, query: object): Promise Get Passkeys Report
public	getRefundReasons(query: object): Promise Get refund reasons
public	getReport(agregateBy: string, query: object): Promise Get transactions report
public	refund(id: string, data: object, query: object): Promise Refund a transaction

Inherited Summary

From class RequestHandler
public	auth: *
public	settings: *
public	delete(path: string, query: object, data: object, headers: object): Promise Delete resource
public	get(path: string, query: object, headers: object): Promise Get resource
public	post(path: string, data: object, query: object, headers: object): Promise Post resource
public	put(path: string, data: object, query: object, headers: object): Promise Put resource
public	request(options: object): Promise Create new request promise
public	setEnv(env: string) Set Environment
public	setUrl(url: string) Set API url
public	upload(path: string, formData: object, query: object, headers: object): Promise Upload files

Public Methods

public cancel(id: string, query: object): Promise source

Cancel a pending transaction

Params:

Name	Type	Attribute	Description
id	string		Transaction ID.
query	object	optional	Optional request parameters.

Return:

Promise

public capture(id: string, query: object): Promise source

Capture an authorized transaction

Params:

Name	Type	Attribute	Description
id	string		Transaction ID.
query	object	optional	Optional request parameters.

Return:

Promise

public chargeback(id: string, type: string, body: string, query: object): Promise source

Include chargeback transaction

Params:

Name	Type	Attribute	Description
id	string		Transaction ID.
type	string		Required.
body	string	optional	Optional.
query	object	optional	Optional request parameters.

Return:

Promise

public getById(id: string, query: object): Promise source

Get a transaction by ID

Params:

Name	Type	Attribute	Description
id	string		Transaction ID.
query	object	optional	Optional request parameters.

Return:

Promise

public getDecisionReasons(query: object): Promise source

Get decision reason

Params:

Name	Type	Attribute	Description
query	object	optional	Require parameters.

Return:

Promise

public getList(query: object): Promise source

Get a list of transactions

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

public getPasskeysReport(eventId: number, query: object): Promise source

Get Passkeys Report

Params:

Name	Type	Attribute	Description
eventId	number		Event ID.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...
const ing = new Sdk();

ing.api.getPasskeysReport(21232, { status: 'pending' })
.then((response) => {
    console.log(response);
})
.catch((error) => {
    console.log(error);
});

public getRefundReasons(query: object): Promise source

Get refund reasons

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

public getReport(agregateBy: string, query: object): Promise source

Get transactions report

Params:

Name	Type	Attribute	Description
agregateBy	string	optional	Optional: 'status'.
query	object	optional	Optional request parameters.

Return:

Promise

public refund(id: string, data: object, query: object): Promise source

Refund a transaction

Params:

Name	Type	Attribute	Description
id	string		Transaction ID.
data	object	optional	Optional transaction data.
query	object	optional	Optional request parameters.

Return:

Promise