Payin Intent

Introduction

A Payin Intent tracks and handles the entire process of collecting a customer’s payment. A Payin intent moves through different statuses before it can create a single successful charge.

🌐
Supported Countries: Payin Intent is currently supported in Singapore and Australia.

View all Payin Intents

To view all the payin intents, navigate to Receivables → Payin Intents

Payin Intent Use Cases

A pay-in intent is created for both one-time and recurring payments, specifically, for one-time payments when the capture type at checkout is set to Delayed Capture or Authorization Hold, and for recurring payments when a payment schedule is set up. The following table outlines the permitted actions for each Payin Intent, categorized by capture type.

Payin Intent Use Case	Description	Available for Capture Types
Capture Full Payment	This option allows you to capture the full authorised amount. If the authorised amount is not captured within the allowable timeframe, the authorisation will expire or be released, and the funds will become available again to the cardholder. The window during which the funds remain authorized varies by transaction type and card network	Authorization Hold
Increase Authorization Amount	This allows you to increase the hold on the customer’s card on top of the existing authorized amount, for example, to cover additional charges like surcharges or incidentals before capturing funds.	Authorization Hold
Capture Partial Payment	This option lets you capture only a part of the authorized amount. When selected, you’ll need to specify the number of installments for capturing the payment, ensuring each capture is less than or equal to the total authorized amount. Once all installments are completed, any remaining authorized amount that hasn’t been captured will be automatically released back to the cardholder.	Authorization Hold
Cancel Capture	You can cancel a capture if you no longer wish to proceed with the transaction. This action cancels the authorization, and the funds that were initially reserved are now transferred back to the user.	Authorization Hold Delayed Capture

Payin Intent Status

The payin intent status reflects where the payment is in the overall flow from initial request to final completion. The table below outlines the different payin intent statuses.

Status	Description
CREATED	PayIn Intent has been initialized with payment details (amount, currency, customer) but no payment processing has begun. The intent is waiting to be triggered for execution.
COMPLETED	PayIn Intent has successfully captured the payment and funds are secured.
FAILED	PayIn Intent encountered an error that prevented successful payment completion. Common causes include insufficient funds, card declined by issuer, failed authentication, network timeouts, etc.
EXPIRED	PayIn Intent has reached its time limit without completion. This occurs when authentication sessions timeout, payment authorizations expire (typically 7-30 days depending on the Network), or the intent exceeds its configured validity period.
CANCELLED	PayIn Intent has been deliberately terminated before completion. This can be triggered by merchant cancellation, customer abandonment, system-initiated cancellation due to fraud detection, or duplicate payment prevention.

Payin Intent Auth Status

The authorization status shows whether the customer’s bank has approved or declined the authorization, which determines whether funds can be captured or if customer action is needed. The table below outlines the different authorization statuses of the payin intent.

Status	Description
CREATED	The payin intent has been created and is now waiting for the customer to provide card details or confirm the payment.
AUTHORIZED	The payin intent has been authorized, and the requested amount has been reserved for capture.
CAPTURED	The entire authorized amount has been successfully collected from the cardholder. No further action is required
PARTIALLY CAPTURED	Only a part of the authorized amount was captured, while the remaining portion is still pending.
FAILED	The payment did not go through due to issues such as insufficient funds, invalid card details, or bank decline.
EXPIRED	The authorization lapsed without capture before the timeout. Funds are released, and a new intent is required to proceed.
CANCELLED	The payment intent was manually cancelled before capture, voiding the authorization hold. No funds were collected.