PaymentCashRequest: {
    amount: string;
    currency: string;
    customer_detail?: PaymentCustomerObject;
    discount_detail?: PaymentDiscountObject;
    invoice_id: string;
    ip_address: string;
    items_detail?: PaymentItemsObject;
    mid: string;
    order_id: string;
    reference_id: string;
    service_charge: string;
    shipping_detail?: PaymentShippingObject;
    totp: string;
}

Parameters to accept and record a cash payment.

Type declaration

  • amount: string

    The total cash amount accepted. Use numbers for dollar amount and up to 2 decimal places for cents. Example $100.00 could be 100 or 100.00

  • currency: string

    ISO 4127 currency code. Default is 'USD'

  • Optional customer_detail?: PaymentCustomerObject

    The payment customer detail object.

  • Optional discount_detail?: PaymentDiscountObject

    The payment discount object

  • invoice_id: string

    Associate payment transaction with an invoice

  • ip_address: string

    Payment originating IP address. If not provided the system will attempt to qualify an ip address from the request host value

  • Optional items_detail?: PaymentItemsObject

    The payment sale items sold array.

  • mid: string

    The merchant account id assigned by the service provider that will accept the cash payment

  • order_id: string

    Unique order ID for this transaction. If not provided, a unique order id will be generated as 'ORDER_<8 random characters>.

  • reference_id: string

    An internal reference id that will be echo'd back in the message response.

  • service_charge: string

    The amount of this transaction that should be allocated to a service charge. Cannot exceed the request amount value. Use numbers for dollar amount and up to 2 decimal places for cents. Example $100.00 could be 100 or 100.0

  • Optional shipping_detail?: PaymentShippingObject

    The payment transaction shipping object.

  • totp: string

    Route a transaction to an external provider. Your servicee provider will provide value(s) required here.

Generated using TypeDoc