Collect

​

Overview

• Displaying available payment methods
• Securely collecting payment information
• Processing the payment
• Handling success and failure scenarios
• Redirecting customers back to your website

​

Benefits of Using Collect

​

Integration Steps

​

1. Create a Payment

// Using fetch in JavaScript
fetch('https://api.notchpay.co/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_PUBLIC_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'XAF',
    customer: {
      name: 'John Doe',
      email: 'john@example.com',
      phone: '+237600000000'
    },
    description: 'Payment for Order #123',
    callback: 'https://your-website.com/callback',
    reference: 'order_123'
  })
})
.then(response => response.json())
.then(data => {
  // Redirect to the collect page
  window.location.href = data.authorization_url;
})
.catch(error => console.error('Error:', error));

​

2. Redirect to Collect

window.location.href = data.authorization_url;
// Example: https://pay.notchpay.co/pay_123456789

​

3. Handle the Callback

https://your-website.com/callback?reference=trx.dhhdjjsj&status=complete&trxref=order_123

fetch(`https://api.notchpay.co/payments/${reference}`, {
  headers: {
    'Authorization': 'YOUR_PUBLIC_KEY'
  }
})
.then(response => response.json())
.then(data => {
  if (data.transaction.status === 'complete') {
    // Payment successful, update your database and show success page
  } else {
    // Payment failed or is still pending
  }
})
.catch(error => console.error('Error:', error));

​

Customization Options

​

Basic Customization

• title: Custom title for the collect page
• description: Detailed description of what the customer is paying for
• callback: URL to redirect after payment completion

fetch('https://api.notchpay.co/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_PUBLIC_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'XAF',
    customer: {
      name: 'John Doe',
      email: 'john@example.com'
    },
    title: 'Premium Package',
    description: 'Access to Premium Features',
    callback: 'https://your-website.com/success',
  })
})

​

Payment Method Restrictions

• locked_channel: Restrict to a specific payment channel
• locked_country: Restrict to payment methods from a specific country
• locked_currency: Restrict to a specific currency

fetch('https://api.notchpay.co/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_PUBLIC_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'XAF',
    customer: {
      name: 'John Doe',
      email: 'john@example.com'
    },
    locked_channel: 'cm.mtn',  // Only allow MTN Mobile Money
    locked_country: 'CM'       // Only allow Cameroon payment methods
  })
})

​

Advanced Customization

1. Go to Settings > Collect
2. Click “Create Custom Collect”
3. Customize colors, fonts, and layout
4. Save your custom collect template

fetch('https://api.notchpay.co/payments', {
  method: 'POST',
  headers: {
    'Authorization': 'YOUR_PUBLIC_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'XAF',
    customer: {
      name: 'John Doe',
      email: 'john@example.com'
    },
    theming: {
        "color": "#F12d7a"
    }
  })
})

​

Payment Statuses

​

Collect Flow

1. Payment Information: The customer sees the payment amount, description, and your business information
2. Payment Method Selection: The customer selects their preferred payment method
3. Payment Details: The customer enters their payment details (e.g., mobile money number)
4. Confirmation: The customer confirms the payment
5. Processing: Notch Pay processes the payment with the selected provider
6. Result: The customer sees the payment result (success or failure)
7. Redirect: The customer is redirected back to your website

​

Testing Collect

1. Switch to Test Mode in your dashboard
2. Create a test payment using your test API key
3. Use test payment methods to simulate different scenarios
4. Verify that your callback handling works correctly

​

Best Practices

1. Pre-fill Customer Information: Provide customer details when creating the payment to streamline the collect process
2. Clear Descriptions: Use clear and concise descriptions so customers know what they’re paying for
3. Responsive Design: Ensure your website is responsive, as many customers will complete payment on mobile devices
4. Error Handling: Implement proper error handling for cases where customers abandon payment or payments fail
5. Webhooks: Set up webhooks for reliable payment notifications, as some customers may not return to your callback URL

​

Troubleshooting

​

Common Issues

• Redirect Not Working: Ensure your callback URL is properly URL-encoded and accessible
• Payment Not Showing: Verify that you’re using the correct API key and that the payment was created successfully
• Customization Not Applied: Check that your logo URL is publicly accessible and that custom parameters are correctly formatted

​

Support

• Check the API Reference for detailed parameter documentation
• Contact our support team for assistance
• Join our developer community to connect with other developers