@apideck/node/dist/gen/models/PosPaymentExternalDetails.d.ts

Apideck Node.js SDK

/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 * Details about an external payment.
 * @export
 * @interface PosPaymentExternalDetails
 */
export interface PosPaymentExternalDetails {
    /**
     * The type of external payment the seller received. It can be one of the following:
     * - CHECK - Paid using a physical check.
     * - BANK_TRANSFER - Paid using external bank transfer.
     * - OTHER\_GIFT\_CARD - Paid using a non-Square gift card.
     * - CRYPTO - Paid using a crypto currency.
     * - SQUARE_CASH - Paid using Square Cash App.
     * - SOCIAL - Paid using peer-to-peer payment applications.
     * - EXTERNAL - A third-party application gathered this payment outside of Square.
     * - EMONEY - Paid using an E-money provider.
     * - CARD - A credit or debit card that Square does not support.
     * - STORED_BALANCE - Use for house accounts, store credit, and so forth.
     * - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals
     * - OTHER - A type not listed here.
     * @type {string}
     * @memberof PosPaymentExternalDetails
     */
    type: PosPaymentExternalDetailsType;
    /**
     * A description of the external payment source. For example,
     * "Food Delivery Service".
     * @type {string}
     * @memberof PosPaymentExternalDetails
     */
    source: string;
    /**
     * An ID to associate the payment to its originating source.
     * @type {string}
     * @memberof PosPaymentExternalDetails
     */
    source_id?: string;
    /**
     * The fees paid to the source. The amount minus this field is the net amount seller receives.
     * @type {number}
     * @memberof PosPaymentExternalDetails
     */
    source_fee_amount?: number;
}
/**
 * @export
 * @enum {string}
 */
export declare enum PosPaymentExternalDetailsType {
    check = "check",
    bank_transfer = "bank_transfer",
    other_gift_card = "other_gift_card",
    crypto = "crypto",
    square_cash = "square_cash",
    social = "social",
    external = "external",
    emoney = "emoney",
    card = "card",
    stored_balance = "stored_balance",
    food_voucher = "food_voucher",
    other = "other"
}
export declare function PosPaymentExternalDetailsFromJSON(json: any): PosPaymentExternalDetails;
export declare function PosPaymentExternalDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PosPaymentExternalDetails;
export declare function PosPaymentExternalDetailsToJSON(value?: PosPaymentExternalDetails | null): any;