Type alias PaymentAchRequest

Type declaration

• ach_detail: PaymentAchObject

  ACH account payment detail object. Required if token value is not provided

• customer_detail: PaymentCustomerObject

  Customer to associate with payment

• Optional 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 memo?: string

  Payment memo provided on customer receipts

• Optional meta_data?: object

  Key-value pairs for storing additional information about the payment in a structured format.

• mid: string

  The merchant account id assigned by the service provider that will process the 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>.

• Optional reference_id?: string

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

• Optional send_receipt?: boolean

  Set true to send the customer an email payment receipt. If true you must provide a customer.email value. Default is false.

• token: string

  ACH payment token value. Required if ach_detail is not provided

• total_amount: string

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

• type: string

  ACH/bank transfer type. Accepted values are 'CREDIT' (payout from merchant account) or 'DEBIT' (draw from a customer account)