CreateInboundPaymentIntentRequest

  • addenda
    Type: string
    min length:  
    1
    max length:  
    80
    required

    Payment intent description, which will also be used as the addenda on any payments made on the payment intent.

  • contact
    Type: object · CreateOrUpdateContactRequest
    required

    A dictionary containing information about the customer to which the payment intent belongs to. If provided, the name/uid will be used to match an existing customer and update it with the data provided. If a match does not exist, a new customer will be created.

    • email
      Type: string
      min length:  
      1      Format: email

      The primary email for the customer. Notifications related to the payment intent (if enabled) will be sent to this email. One of uid or name with email must be provided.

    • name
      Type: string
      min length:  
      1

      Unique name identifying the customer. If uid was not provided and a customer already exists with this name, the existing customer will be used and updated. One of uid or name with email must be provided.

    • phone
      Type: string | null
      max length:  
      11

      An SMS-enabled phone number for the customer. Must be a US or Canadian-based number.

    • secondary_email
      Type: string | nullFormat: email

      A secondary for the customer. Must be different from email. Notifications related to the payment intent (if enabled) will be sent to this email.

    • uid
      Type: stringFormat: uuid

      A unique identifier corresponding to an existing customer. If provided, the existing customer will be used and updated. One of uid or name with email must be provided.

  • total
    Type: string Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$Format: decimal
    required

    The total amount due for the payment intent. Must be greater or equal to 1.00.

  • due_date
    Type: string | nullFormat: date

    The due date for payment of payment intent. Must be a string with format YYYY-MM-DD representing a date in the future.

  • memo
    Type: string
    max length:  
    500

    A private memo for internal use.

  • note
    Type: string
    max length:  
    500

    A note to the payee/customer.

  • send_email
    Type: boolean

    If true, the customer will receive an email notification letting them know the payment intent is available to pay with a payment portal link.

  • send_sms
    Type: boolean

    If true, the customer will receive a sms notification letting them know the payment intent is available to pay with a payment portal link.