Uprails API Reference

Overview

Payment Settings allow you to configure how payments are processed, set up webhooks for real-time notifications, and customize payment behavior for your merchant account.

Profile Information

Your merchant profile contains important identifiers used across the platform:

Field	Description
`Profile Name`	Display name for your profile
`Profile ID`	Unique identifier for your profile (e.g., pro_xxxxx)
`Merchant ID`	Your merchant account identifier
`Payment Response Hash Key`	Secret key for verifying payment response signatures

Payment Behavior Options

Configure how payments are processed with these settings:

Collect billing details from wallets

Enable automatic collection of billing information when customers connect their wallets.

Collect shipping details from wallets

Enable automatic collection of shipping information when customers connect their wallets.

Processor Agnostic

Process payments without being tied to a specific payment processor.

Tokenization Support

Store payment methods securely and reuse them for future transactions.

Network Tokenization

Enable secure card storage and seamless future transactions. Contact support to enable this feature.

Extended Authorization

Enable extended authorization for all payments through your supported processor and payment methods.

Always Enable Overcapture

Allow capturing more than the originally authorized amount within processor limits.

Click to Pay

Enable secure, seamless digital payment solution for quick checkout using saved cards.

Retry Settings

Auto Retries

Automatically re-attempt failed payments using the same payment method details. The system will retry on a defined routed list until successful or all attempts are exhausted.

Manual Retries

Manually re-attempt a failed payment using its original payment ID. You can retry with the same payment method or provide a different one.

Webhook Configuration

Set up webhooks to receive real-time notifications about payment events.

Webhook URL Allowlist

Your webhook URL needs to be manually added to the allowlist. Please reach out to our team for assistance.

Field	Description
`Return URL`	URL to redirect customers after payment completion
`Webhook URL`	Endpoint to receive payment event notifications

Payment Link Settings

Configure settings for payment links:

Field	Description
`Domain Name`	Custom domain used to generate payment links
`Allowed Domain`	Domains allowed to embed payment links (comma-separated)

Custom Headers

Add custom headers and metadata headers to your payment requests for tracking and integration purposes.

Custom Headers Examplejson

{
  "custom_headers": {
    "X-Custom-Header": "value",
    "X-Tracking-ID": "track_123"
  },
  "metadata_headers": {
    "order_id": "ord_456",
    "customer_ref": "cust_789"
  }
}