CHIP Collect icon

CHIP Collect

Work with purchases and payment methods in CHIP Collect
Join our community

Actions13

Overview

This node integrates with the CHIP Collect API to create a purchase transaction. It allows users to specify detailed purchase information such as amount, currency, buyer details, payment methods, and URLs for success, cancellation, and failure redirects. The node supports advanced options like recurring payments, preauthorization, and metadata. It is useful for automating payment collection workflows, generating purchase records, and managing payment processing in e-commerce or billing systems.

Use Case Examples

  1. Creating a purchase with a specified amount and currency, including buyer contact details and restricting payment methods to Visa and Mastercard.
  2. Setting up a purchase with custom success, cancel, and failure URLs to handle user redirection after payment.
  3. Including purchase items with quantities and prices, and sending a receipt email to the buyer automatically.

Properties

Name Meaning
Amount The total amount for the purchase in the smallest currency units (e.g., cents). Required and must be at least 1.
Amount Unit Specifies whether the amount is given in major currency units (e.g., MYR) or minor units (e.g., cents). Automatically converts major units to minor units when sending.
Currency The currency code in ISO 4217 format for the purchase amount. Required.
Description Optional description of the purchase.
Success URL URL to redirect the user after a successful payment. Auto-filled if empty.
Cancel URL URL to redirect the user if the payment is canceled. Auto-filled if empty.
Failure URL URL to redirect the user if the payment fails. Auto-filled if empty.
Success Callback Webhook URL to call on successful payment. Auto-filled if empty.
Language Language for the payment interface.
Timezone Timezone for due dates in IANA format (e.g., Asia/Kuala_Lumpur).
Due Strict Whether to enforce strict due date.
Email Message Custom message to include in the receipt email.
Notes Internal notes for the purchase.
Payment Method Whitelist Restricts available payment methods for the purchase. At least one method must be selected.
Recurring Whether the purchase is recurring.
Skip Capture Whether to skip capture of the payment.
Preauthorization Whether to preauthorize the payment.
Buyer Name Full name of the buyer.
Buyer Email Email address of the buyer.
Buyer Phone Phone number of the buyer with country code.
Buyer Street Street address of the buyer.
Buyer City City of the buyer.
Buyer ZIP ZIP code of the buyer.
Buyer Country Country of the buyer.
Buyer State State of the buyer.
Shipping Street Shipping street address.
Shipping City Shipping city.
Shipping ZIP Shipping ZIP code.
Shipping Country Shipping country.
Shipping State Shipping state.
Country Country code for phone number normalization and payment methods.
Reference Custom reference number for the system.
Metadata Custom metadata key-value pairs.
Send Receipt Whether to send a receipt email to the buyer.
Receipt Email Custom email address for receipts; uses buyer email if empty.
Tax Amount Tax amount in smallest currency units.
Discount Amount Discount amount in smallest currency units.
Shipping Amount Shipping cost in smallest currency units.
Purchase Items List of purchase items with name, quantity, and amount per item.
Items Amount Unit Interpret item amounts as major or minor currency units and auto-convert to smallest units when sending.

Output

JSON

  • json
    • id - Unique identifier of the created purchase.
    • amount - Total amount of the purchase in smallest currency units.
    • currency - Currency code of the purchase.
    • description - Description of the purchase.
    • status - Current status of the purchase (e.g., pending, paid).
    • payment_method_whitelist - List of allowed payment methods for the purchase.
    • recurring - Indicates if the purchase is recurring.
    • reference - Custom reference number associated with the purchase.
    • send_receipt - Indicates if a receipt email was sent.
    • client
      * full_name - Full name of the buyer.
      * email - Email address of the buyer.
      * phone - Phone number of the buyer.
    • products - Array of purchase items with name, quantity, and price.
    • success_redirect - URL to redirect after successful payment.
    • cancel_redirect - URL to redirect if payment is canceled.
    • failure_redirect - URL to redirect if payment fails.

Dependencies

  • CHIP Collect API
  • API key credential for authentication

Troubleshooting

  • Ensure the API key and brand ID credentials are correctly configured and valid UUID format is used for brand ID.
  • Validate email addresses for buyerEmail and receiptEmail to avoid format errors.
  • Make sure at least one payment method is selected in the whitelist to prevent errors.
  • Check that URLs for success, cancel, failure, and webhook callbacks use HTTPS protocol if provided.
  • If amount is specified in major units, verify it is correctly converted to smallest units (e.g., cents).
  • Handle network or API errors gracefully and verify the API endpoint is reachable.

Links

Discussion