CreatePaymentModel

Payment details for an order you are creating yourself. Send the card fields together with paymentOption.

Card data reaching this endpoint passes through your systems, which puts you in PCI DSS scope. If you would rather not take that on, hand the customer to the planCheckoutUrl returned by a plan search instead and Chaiz collects payment.

  • paymentOption
    Type: string · PaymentOptionenum
    required

    The payment term, which also selects the price. Always required. Values: 0 = monthly installments, 2 = pay in full.

    The enum member names do not read the way you would expect, so use the numbers above. Which options are available depends on your account and on the plan's duration; a value your account does not allow is rejected.

    values
    • Default
    • Half
    • Full
  • accountNumber
    Type: string | null
    min length:  
    13
    max length:  
    16
    Format: credit-card

    Card number, 13 to 16 digits, no spaces or dashes. In UAT use 4111111111111111 (the standard Visa test number).

  • creditCardExpirationDateString
    Type: string | null

    Card expiration date as MM/YYYY. Note the four-digit year. Must be a valid future date.

  • cvc
    Type: string | null
    min length:  
    3
    max length:  
    5
    Pattern: ^\d+$

    Card security code (CVV/CVC), 3 to 5 digits.

  • methodType
    Type: string · PaymentMethodTypeenum

    Possible values: None (0) - None, VISA (1) - Visa, MASTERCARD (2) - Master Card, AmericanExpress (3) - American Express, Discover (4) - Discover, ACHSavings (5) - ACH Savings, ACHChecking (6) - ACH Checking

    values
    • None
    • VISA
    • MASTERCARD
    • AmericanExpress
    • Discover
    • ACHSavings
    • ACHChecking