Create Payin Intent

A Payin Intent reserves or authorizes funds for a payment that may be captured immediately or later. Use this endpoint to create a Payin Intent either standalone or linked to a Recurring Payin.

  • Supports configurable capture behavior via is_auto_capture and capture_delay (max 14 days).

For more information about Payins, see the Payin APIs and the Hosted Checkout documentation.

Body Params
string

Customer ID (customer_*)

string
required

Payin method name.

string

Card Tokenization ID (cardtkn*)

number
required
≥ 0.01

Transaction amount

string
required

ISO 4217 currency code

string

ISO 3166-1 alpha-2 country code

uri

Webhook URL for intent updates

integer
1 to 7

Delay in days before auto capture (1 to 7 Days)

boolean
Defaults to true

Whether to auto capture the payment

uri
required

Redirect URL on success/failure if advanced_redirect_url not provided

advanced_redirect_url
object
metadata
object

Custom key-value metadata

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8