@channelpayments/node-sdk 1.24.0

package/dist/mjs/src/models/CreatePaymentMethodDto.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface CreatePaymentMethodDto
+ */
+export interface CreatePaymentMethodDto {
+    /**
+     * The payment method
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    method: CreatePaymentMethodDtoMethodEnum;
+    /**
+     * The 13 - 19 digit card number
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    number: string;
+    /**
+     * The expiration date of the card, formatted MM/YY
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    expirationDate: string;
+    /**
+     * The external ID of the buyer to associate the payment to
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    externalBuyerId?: string;
+    /**
+     * The Channel Payments ID of the buyer to associate the payment to
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    buyerId?: string;
+    /**
+     * An external ID to match the card against your own records
+     * @type {string}
+     * @memberof CreatePaymentMethodDto
+     */
+    externalPaymentMethodId?: string;
+}
+/**
+ * @export
+ */
+export declare const CreatePaymentMethodDtoMethodEnum: {
+    readonly Card: "CARD";
+};
+export type CreatePaymentMethodDtoMethodEnum = typeof CreatePaymentMethodDtoMethodEnum[keyof typeof CreatePaymentMethodDtoMethodEnum];
+/**
+ * Check if a given object implements the CreatePaymentMethodDto interface.
+ */
+export declare function instanceOfCreatePaymentMethodDto(value: object): boolean;
+export declare function CreatePaymentMethodDtoFromJSON(json: any): CreatePaymentMethodDto;
+export declare function CreatePaymentMethodDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePaymentMethodDto;
+export declare function CreatePaymentMethodDtoToJSON(value?: CreatePaymentMethodDto | null): any;

package/dist/mjs/src/models/CreatePaymentMethodDto.js

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+/**
+ * @export
+ */
+export const CreatePaymentMethodDtoMethodEnum = {
+    Card: 'CARD'
+};
+/**
+ * Check if a given object implements the CreatePaymentMethodDto interface.
+ */
+export function instanceOfCreatePaymentMethodDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "method" in value;
+    isInstance = isInstance && "number" in value;
+    isInstance = isInstance && "expirationDate" in value;
+    return isInstance;
+}
+export function CreatePaymentMethodDtoFromJSON(json) {
+    return CreatePaymentMethodDtoFromJSONTyped(json, false);
+}
+export function CreatePaymentMethodDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'method': json['method'],
+        'number': json['number'],
+        'expirationDate': json['expirationDate'],
+        'externalBuyerId': !exists(json, 'externalBuyerId') ? undefined : json['externalBuyerId'],
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+        'externalPaymentMethodId': !exists(json, 'externalPaymentMethodId') ? undefined : json['externalPaymentMethodId'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CreatePaymentMethodDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'method': value.method,
+        'number': value.number,
+        'expirationDate': value.expirationDate,
+        'externalBuyerId': value.externalBuyerId,
+        'buyerId': value.buyerId,
+        'externalPaymentMethodId': value.externalPaymentMethodId,
+    };
+}

package/dist/mjs/src/models/CreateTransactionDto.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { CreateTransactionDtoPaymentMethod } from './CreateTransactionDtoPaymentMethod';
+/**
+ *
+ * @export
+ * @interface CreateTransactionDto
+ */
+export interface CreateTransactionDto {
+    /**
+     * The amount to charge the buyer.
+     * @type {number}
+     * @memberof CreateTransactionDto
+     */
+    amount: number;
+    /**
+     * The ISO-4217 currency code of the amount to charge the buyer.
+     * @type {string}
+     * @memberof CreateTransactionDto
+     */
+    currency: CreateTransactionDtoCurrencyEnum;
+    /**
+     *
+     * @type {CreateTransactionDtoPaymentMethod}
+     * @memberof CreateTransactionDto
+     */
+    paymentMethod: CreateTransactionDtoPaymentMethod;
+    /**
+     * Defines the intent of the transaction. Available options include: authorize, capture
+     * @type {string}
+     * @memberof CreateTransactionDto
+     */
+    intent?: CreateTransactionDtoIntentEnum;
+    /**
+     * Whether or not to exclude the convenience fee from the transaction amount.
+     * @type {boolean}
+     * @memberof CreateTransactionDto
+     */
+    excludeCfee?: boolean;
+    /**
+     * The 2-letter ISO code of the country of the transaction.
+     * @type {string}
+     * @memberof CreateTransactionDto
+     */
+    country?: string;
+    /**
+     * External identifier that can be used to match the transactions against your own records
+     * @type {string}
+     * @memberof CreateTransactionDto
+     */
+    externalTransactionId?: string;
+}
+/**
+ * @export
+ */
+export declare const CreateTransactionDtoCurrencyEnum: {
+    readonly Usd: "USD";
+    readonly Cad: "CAD";
+    readonly Aud: "AUD";
+};
+export type CreateTransactionDtoCurrencyEnum = typeof CreateTransactionDtoCurrencyEnum[keyof typeof CreateTransactionDtoCurrencyEnum];
+/**
+ * @export
+ */
+export declare const CreateTransactionDtoIntentEnum: {
+    readonly Capture: "capture";
+    readonly Authorize: "authorize";
+};
+export type CreateTransactionDtoIntentEnum = typeof CreateTransactionDtoIntentEnum[keyof typeof CreateTransactionDtoIntentEnum];
+/**
+ * Check if a given object implements the CreateTransactionDto interface.
+ */
+export declare function instanceOfCreateTransactionDto(value: object): boolean;
+export declare function CreateTransactionDtoFromJSON(json: any): CreateTransactionDto;
+export declare function CreateTransactionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTransactionDto;
+export declare function CreateTransactionDtoToJSON(value?: CreateTransactionDto | null): any;

package/dist/mjs/src/models/CreateTransactionDto.js

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+import { CreateTransactionDtoPaymentMethodFromJSON, CreateTransactionDtoPaymentMethodToJSON, } from './CreateTransactionDtoPaymentMethod';
+/**
+ * @export
+ */
+export const CreateTransactionDtoCurrencyEnum = {
+    Usd: 'USD',
+    Cad: 'CAD',
+    Aud: 'AUD'
+};
+/**
+ * @export
+ */
+export const CreateTransactionDtoIntentEnum = {
+    Capture: 'capture',
+    Authorize: 'authorize'
+};
+/**
+ * Check if a given object implements the CreateTransactionDto interface.
+ */
+export function instanceOfCreateTransactionDto(value) {
+    let isInstance = true;
+    isInstance = isInstance && "amount" in value;
+    isInstance = isInstance && "currency" in value;
+    isInstance = isInstance && "paymentMethod" in value;
+    return isInstance;
+}
+export function CreateTransactionDtoFromJSON(json) {
+    return CreateTransactionDtoFromJSONTyped(json, false);
+}
+export function CreateTransactionDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'amount': json['amount'],
+        'currency': json['currency'],
+        'paymentMethod': CreateTransactionDtoPaymentMethodFromJSON(json['paymentMethod']),
+        'intent': !exists(json, 'intent') ? undefined : json['intent'],
+        'excludeCfee': !exists(json, 'excludeCfee') ? undefined : json['excludeCfee'],
+        'country': !exists(json, 'country') ? undefined : json['country'],
+        'externalTransactionId': !exists(json, 'externalTransactionId') ? undefined : json['externalTransactionId'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CreateTransactionDtoToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amount': value.amount,
+        'currency': value.currency,
+        'paymentMethod': CreateTransactionDtoPaymentMethodToJSON(value.paymentMethod),
+        'intent': value.intent,
+        'excludeCfee': value.excludeCfee,
+        'country': value.country,
+        'externalTransactionId': value.externalTransactionId,
+    };
+}

package/dist/mjs/src/models/CreateTransactionDtoPaymentMethod.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ * The payment method.
+ * @export
+ * @interface CreateTransactionDtoPaymentMethod
+ */
+export interface CreateTransactionDtoPaymentMethod {
+    /**
+     * The payment method.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    method: CreateTransactionDtoPaymentMethodMethodEnum;
+    /**
+     * The 13 - 19 digit card number. Must be unset is method is not CARD.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    number?: string;
+    /**
+     * The 3 or 4 digit code often found on the back of the card. Often referred to as the CVV or CVD.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    securityCode?: string;
+    /**
+     * The expiration date of the card, formatted MM/YY. Must be unset if method is not CARD.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    expirationDate?: string;
+    /**
+     * The id of the buyer to associate the payment to. Must be unset if method is ID.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    externalBuyerId?: string;
+    /**
+     * The id of the buyer to associate the payment to. Must be unset if method is ID.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    buyerId?: string;
+    /**
+     * The id of the stored payment method to use. Must be unset if method is not ID.
+     * @type {string}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    paymentMethodId?: string;
+    /**
+     * Whether or not to also try and store the payment method for future use
+     * @type {boolean}
+     * @memberof CreateTransactionDtoPaymentMethod
+     */
+    store?: boolean;
+}
+/**
+ * @export
+ */
+export declare const CreateTransactionDtoPaymentMethodMethodEnum: {
+    readonly Card: "CARD";
+    readonly Id: "ID";
+};
+export type CreateTransactionDtoPaymentMethodMethodEnum = typeof CreateTransactionDtoPaymentMethodMethodEnum[keyof typeof CreateTransactionDtoPaymentMethodMethodEnum];
+/**
+ * Check if a given object implements the CreateTransactionDtoPaymentMethod interface.
+ */
+export declare function instanceOfCreateTransactionDtoPaymentMethod(value: object): boolean;
+export declare function CreateTransactionDtoPaymentMethodFromJSON(json: any): CreateTransactionDtoPaymentMethod;
+export declare function CreateTransactionDtoPaymentMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTransactionDtoPaymentMethod;
+export declare function CreateTransactionDtoPaymentMethodToJSON(value?: CreateTransactionDtoPaymentMethod | null): any;

package/dist/mjs/src/models/CreateTransactionDtoPaymentMethod.js

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+/**
+ * @export
+ */
+export const CreateTransactionDtoPaymentMethodMethodEnum = {
+    Card: 'CARD',
+    Id: 'ID'
+};
+/**
+ * Check if a given object implements the CreateTransactionDtoPaymentMethod interface.
+ */
+export function instanceOfCreateTransactionDtoPaymentMethod(value) {
+    let isInstance = true;
+    isInstance = isInstance && "method" in value;
+    return isInstance;
+}
+export function CreateTransactionDtoPaymentMethodFromJSON(json) {
+    return CreateTransactionDtoPaymentMethodFromJSONTyped(json, false);
+}
+export function CreateTransactionDtoPaymentMethodFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'method': json['method'],
+        'number': !exists(json, 'number') ? undefined : json['number'],
+        'securityCode': !exists(json, 'securityCode') ? undefined : json['securityCode'],
+        'expirationDate': !exists(json, 'expirationDate') ? undefined : json['expirationDate'],
+        'externalBuyerId': !exists(json, 'externalBuyerId') ? undefined : json['externalBuyerId'],
+        'buyerId': !exists(json, 'buyerId') ? undefined : json['buyerId'],
+        'paymentMethodId': !exists(json, 'paymentMethodId') ? undefined : json['paymentMethodId'],
+        'store': !exists(json, 'store') ? undefined : json['store'],
+    };
+    return removeNullUndefined(typed);
+}
+export function CreateTransactionDtoPaymentMethodToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'method': value.method,
+        'number': value.number,
+        'securityCode': value.securityCode,
+        'expirationDate': value.expirationDate,
+        'externalBuyerId': value.externalBuyerId,
+        'buyerId': value.buyerId,
+        'paymentMethodId': value.paymentMethodId,
+        'store': value.store,
+    };
+}

package/dist/mjs/src/models/ErrorEntity.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+/**
+ *
+ * @export
+ * @interface ErrorEntity
+ */
+export interface ErrorEntity {
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorEntity
+     */
+    statusCode?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity
+     */
+    message?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity
+     */
+    path?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ErrorEntity
+     */
+    timestamp?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity
+     */
+    method?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorEntity
+     */
+    requestId?: string;
+}
+/**
+ * Check if a given object implements the ErrorEntity interface.
+ */
+export declare function instanceOfErrorEntity(value: object): boolean;
+export declare function ErrorEntityFromJSON(json: any): ErrorEntity;
+export declare function ErrorEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEntity;
+export declare function ErrorEntityToJSON(value?: ErrorEntity | null): any;

package/dist/mjs/src/models/ErrorEntity.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import { exists, removeNullUndefined } from '../runtime';
+/**
+ * Check if a given object implements the ErrorEntity interface.
+ */
+export function instanceOfErrorEntity(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function ErrorEntityFromJSON(json) {
+    return ErrorEntityFromJSONTyped(json, false);
+}
+export function ErrorEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    const typed = {
+        'statusCode': !exists(json, 'statusCode') ? undefined : json['statusCode'],
+        'message': !exists(json, 'message') ? undefined : json['message'],
+        'path': !exists(json, 'path') ? undefined : json['path'],
+        'timestamp': !exists(json, 'timestamp') ? undefined : (new Date(json['timestamp'])),
+        'method': !exists(json, 'method') ? undefined : json['method'],
+        'requestId': !exists(json, 'requestId') ? undefined : json['requestId'],
+    };
+    return removeNullUndefined(typed);
+}
+export function ErrorEntityToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'statusCode': value.statusCode,
+        'message': value.message,
+        'path': value.path,
+        'timestamp': value.timestamp === undefined ? undefined : (value.timestamp.toISOString()),
+        'method': value.method,
+        'requestId': value.requestId,
+    };
+}

package/dist/mjs/src/models/MerchantAccountEntity.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Channel Payments API
+ *
+ * NOTE: This class is auto generated. Do not edit the class manually.
+ *
+ */
+import type { MerchantAccountEntityCfee } from './MerchantAccountEntityCfee';
+import type { MerchantGatewayEntity } from './MerchantGatewayEntity';
+/**
+ *
+ * @export
+ * @interface MerchantAccountEntity
+ */
+export interface MerchantAccountEntity {
+    /**
+     * The alphanumeric ID of the merchant account
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    merchantAccountId: string;
+    /**
+     * The associated merchant ID
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    merchantId?: string;
+    /**
+     * The issued MID (Merchant ID)
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    issuedMid: string;
+    /**
+     * The payment service provider
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    psp: MerchantAccountEntityPspEnum;
+    /**
+     *
+     * @type {MerchantAccountEntityCfee}
+     * @memberof MerchantAccountEntity
+     */
+    cfee: MerchantAccountEntityCfee;
+    /**
+     * The accepted currencies
+     * @type {Array<string>}
+     * @memberof MerchantAccountEntity
+     */
+    acceptedCurrencies: Array<MerchantAccountEntityAcceptedCurrenciesEnum>;
+    /**
+     * The date the merchant was created
+     * @type {Date}
+     * @memberof MerchantAccountEntity
+     */
+    createdAt: Date;
+    /**
+     * The date the merchant was last updated
+     * @type {Date}
+     * @memberof MerchantAccountEntity
+     */
+    updatedAt: Date;
+    /**
+     * The payment method
+     * @type {string}
+     * @memberof MerchantAccountEntity
+     */
+    paymentMethod: MerchantAccountEntityPaymentMethodEnum;
+    /**
+     *
+     * @type {Array<MerchantGatewayEntity>}
+     * @memberof MerchantAccountEntity
+     */
+    gateways?: Array<MerchantGatewayEntity>;
+}
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityPspEnum: {
+    readonly Tsys: "TSYS";
+    readonly Nashville: "NASHVILLE";
+    readonly ChannelPayments: "CHANNEL_PAYMENTS";
+};
+export type MerchantAccountEntityPspEnum = typeof MerchantAccountEntityPspEnum[keyof typeof MerchantAccountEntityPspEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityAcceptedCurrenciesEnum: {
+    readonly Usd: "USD";
+    readonly Aud: "AUD";
+    readonly Cad: "CAD";
+};
+export type MerchantAccountEntityAcceptedCurrenciesEnum = typeof MerchantAccountEntityAcceptedCurrenciesEnum[keyof typeof MerchantAccountEntityAcceptedCurrenciesEnum];
+/**
+ * @export
+ */
+export declare const MerchantAccountEntityPaymentMethodEnum: {
+    readonly Card: "CARD";
+    readonly Ach: "ACH";
+};
+export type MerchantAccountEntityPaymentMethodEnum = typeof MerchantAccountEntityPaymentMethodEnum[keyof typeof MerchantAccountEntityPaymentMethodEnum];
+/**
+ * Check if a given object implements the MerchantAccountEntity interface.
+ */
+export declare function instanceOfMerchantAccountEntity(value: object): boolean;
+export declare function MerchantAccountEntityFromJSON(json: any): MerchantAccountEntity;
+export declare function MerchantAccountEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): MerchantAccountEntity;
+export declare function MerchantAccountEntityToJSON(value?: MerchantAccountEntity | null): any;