Type alias PaymentCardRequest

Type declaration

• Optional card_detail?: PaymentCardObject

  The credit card detail object. Required if token_detail and track_detail is not provided

• Optional currency?: string

  The ISO-4127 3 character currency code accepted for this transaction. Defaults to 'USD

• Optional customer_detail?: PaymentCustomerObject

  The payment customer detail object. Required for type L2 Level 2 transactions and type L3 Level 3 transactions

• Optional discount_detail?: PaymentDiscountObject

  The payment discount object

• Optional invoice_id?: string

  Associate payment transaction with an invoice

• 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 items_detail?: PaymentItemsObject

  The payment sale items sold array. At least one item object must be provided for type L3 Level 3 transactions

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

  Associate payment transaction with a purchase order number. Required for type L2 Level 2 transactions and type L3 Level 3 transactions

• Optional reference_id?: string

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

• Optional risk_score?: string

  Risk score to associate with payment transaction.

• 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.

• Optional service_charge?: string

  The amount of this transaction that should be allocated to a service charge. Cannot exceed payment 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.

• Optional terminal_id?: string

  A terminal id for processing (can be use as a reference). Required for marketplace transactions

• Optional three_ds?: PaymentCard3dsObject

  The payment 3-D Secure object.

• Optional token_detail?: PaymentCardTokenObject

  The credit card token detail object. Required if card_detail and track_detail is not provided

• Optional topt?: string

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

• 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

• Optional total_tax_amount?: string

  The total tax amount for this transaction. Required for type Level 2 and type Level 3 transactions.

• track_detail: PaymentCardTrackObject

  The credit card magenetic stripe data. required if card_detail and token_detail is not provided

• type: "string"

  Set processing type. Accepted values are 'sale' for an authorize/capture transaction, 'authorize' for a pre-authorization amount, 'L2' for a Level 2 B2B sale transactions and 'L3' for high value B2B/B2G Level 3 sale transactions