privacy.com
Version:
Wrapper for the Privacy.com API using Axios and TypeScript
35 lines (34 loc) • 1.35 kB
TypeScript
import { Transaction } from "../../objects";
import { GetEndpoint, GetRequestPaginatedResponse } from ".";
/**
* List transactions associated with the privacy account or a specific card
*/
export declare class ListTransactionsRequest extends GetEndpoint {
path: string;
params: ListTransactionsParams;
constructor(params?: ListTransactionsParams);
}
/**
* Parameters for {@link ListTransactionsRequest}
* @defaultValue { approval_status: "ALL" }
*/
export declare type ListTransactionsParams = {
approval_status: "ALL"
/** List approved transactions */
| "APPROVALS"
/** List declined transactions */
| "DECLINES";
/** For pagination. The default is one */
page?: number;
/** For pagination. The default value page size is 50 and the maximum is 1,000 */
page_size?: number;
/** Date string in the form YYYY-MM-DD, only transactions created after the specified date will be included */
begin?: string;
/** Date string in the form YYYY-MM-DD, only transactions created before the specified date will be included */
end?: string;
/** Filters transactions associated with a specific card */
card_token?: string;
/** Returns a specific transaction */
transaction_token?: string;
};
export declare type ListTransactionsResponse = GetRequestPaginatedResponse<Transaction>;