Sign in

v1

latestOpenAPI 3.0.02026-07-26280204.9 KB
Payin Intent

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.

post/payin-intent

Request body

customer_idstring

Customer ID (customer_*)

payin_method_namestring required

Payin method name.

card_tokenization_idstring

Card Tokenization ID (card_tkn_*)

amountnumber required

Transaction amount

currencystring required

ISO 4217 currency code

countrystring

ISO 3166-1 alpha-2 country code

webhook_urlstring uri

Webhook URL for intent updates

capture_delayinteger

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

is_auto_captureboolean

Whether to auto capture the payment

redirect_urlstring uri required

Redirect URL on success/failure if advanced_redirect_url not provided

metadataobject

Custom key-value metadata

Example request

{
  "payin_method_name": "sg_card_visa_sgd",
  "currency": "SGD",
  "country": "SG",
  "is_auto_capture": true,
  "amount": 518
}

Response

Created