Payment intents

API Version

Product Catalog

Library

PaymentIntent is created to help you through the 3DS flow of collecting payment from your customer. It is necessary only for implementing 3DS flow using Chargebee.js

Sample payment intent [ JSON ]

{
    "amount": 5000,
    "created_at": 1517479728,
    "currency_code": "USD",
    "expires_at": 1517481528,
    "gateway": "chargebee",
    "gateway_account_id": "gw___test__3Nl9RGqRcPqUhf2",
    "id": "__test__3Nl9RLTRcPqUp95T__test__RPn0gcdsvkZRdHYu1mDu93JGuGAxcdJYGz",
    "modified_at": 1568801328,
    "object": "payment_intent",
    "status": "inited"
}

id

string, max chars=150

Identifier for PaymentIntent.

status

enumerated string

Current status of PaymentIntent.

Possible values are

currency_code

optional, string, max chars=3

The currency code (ISO 4217 format) of the amount used in transaction.

amount

in cents, min=0

Amount(in cents) to be authorized for 3DS flow.

gateway_account_id

string, max chars=50

The gateway account used for performing the 3DS flow.

expires_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent will expire if left unconsumed.

reference_id

optional, string, max chars=200

Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.

success_url

optional, string, max chars=250

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

failure_url

optional, string, max chars=250

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

created_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent was created.

modified_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent was last modified.

customer_id

string, max chars=50

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

See also

Customer resource lookup and creation

gateway

optional, string

Gateway associated with the PaymentIntent.

active_payment_attempt
Show attributes [+]

optional, payment_attempt

Active payment attempt for the PaymentIntent.

id

string, max chars=150

Identifier for PaymentIntent.

status

enumerated string

Current status of PaymentIntent.

Possible values are

currency_code

optional, string, max chars=3

The currency code (ISO 4217 format) of the amount used in transaction.

amount

in cents, min=0

Amount(in cents) to be authorized for 3DS flow.

gateway_account_id

string, max chars=50

The gateway account used for performing the 3DS flow.

expires_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent will expire if left unconsumed.

reference_id

optional, string, max chars=200

Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.

success_url

optional, string, max chars=250

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

failure_url

optional, string, max chars=250

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

created_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent was created.

modified_at

timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent was last modified.

customer_id

string, max chars=50

See also

Customer resource lookup and creation

gateway

optional, string

Gateway associated with the PaymentIntent.

active_payment_attempt

optional, payment_attempt

Active payment attempt for the PaymentIntent.

Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.

While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our Estimate API.

Sample Request

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v1/payment_intents \
     -u {site_api_key}:\
     -d amount=5000 \
     -d currency_code="USD"

copy

Click to Copy

200:

STATUS

Sample Response [ JSON ]

{
    "payment_intent": {
        "amount": 5000,
        "created_at": 1517479728,
        "currency_code": "USD",
        "expires_at": 1517481528,
        "gateway": "chargebee",
        "gateway_account_id": "gw___test__3Nl9RGqRcPqUhf2",
        "id": "__test__3Nl9RLTRcPqUp95T__test__RPn0gcdsvkZRdHYu1mDu93JGuGAxcdJYGz",
        "modified_at": 1568801328,
        "object": "payment_intent",
        "status": "inited"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/payment_intents

customer_id[]

optional, string, max chars=50

See also

Customer resource lookup and creation .

amount[]

required, in cents, min=0

Amount(in cents) to be authorized for 3DS flow.

currency_code[]

required, string, max chars=3

The currency code (ISO 4217 format) of the amount used in transaction.

gateway_account_id[]

optional, string, max chars=50

The gateway account used for performing the 3DS flow.

reference_id[]

optional, string, max chars=200

Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.

success_url[]

optional, string, max chars=250

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

failure_url[]

optional, string, max chars=250

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

payment_intent

always returned
Resource object representing payment_intent

Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.

Sample Request

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v1/payment_intents/__test__3Nl9RLTRcPqe8S5U__test__TvxVbiOu9KZfwtvCm36CX8lpqmeqUSEM \
     -u {site_api_key}:\
     -d amount=4000 \
     -d currency_code="USD"

copy

Click to Copy

200:

STATUS

Sample Response [ JSON ]

{
    "payment_intent": {
        "amount": 4000,
        "created_at": 1517479764,
        "currency_code": "USD",
        "expires_at": 1517481564,
        "gateway": "chargebee",
        "gateway_account_id": "gw___test__3Nl9RDTRcPqczp2",
        "id": "__test__3Nl9RLTRcPqe8S5U__test__TvxVbiOu9KZfwtvCm36CX8lpqmeqUSEM",
        "modified_at": 1568801376,
        "object": "payment_intent",
        "status": "inited"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/payment_intents/{payment-intent-id}

amount[]

optional, in cents, min=0

Amount(in cents) to be authorized for 3DS flow.

currency_code[]

optional, string, max chars=3

The currency code (ISO 4217 format) of the amount used in transaction.

gateway_account_id[]

optional, string, max chars=50

The gateway account used for performing the 3DS flow.

success_url[]

optional, string, max chars=250

The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

failure_url[]

optional, string, max chars=250

The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal , sofort , dotpay or giropay .

payment_intent

always returned
Resource object representing payment_intent

Retrieves the PaymentIntent resource.

Sample Request

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v1/payment_intents/__test__3Nl9RLTRcPqLy55S__test__ZyvWdyZ0cdD963AnCrZivHu2oFQFo8OJU \
     -u {site_api_key}:

copy

Click to Copy

200:

STATUS

Sample Response [ JSON ]

{
    "payment_intent": {
        "amount": 5000,
        "created_at": 1517479694,
        "currency_code": "USD",
        "expires_at": 1517481494,
        "gateway": "chargebee",
        "gateway_account_id": "gw___test__3Nl9RGbRcPqLrS2",
        "id": "__test__3Nl9RLTRcPqLy55S__test__ZyvWdyZ0cdD963AnCrZivHu2oFQFo8OJU",
        "modified_at": 1568801294,
        "object": "payment_intent",
        "status": "inited"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v1/payment_intents/{payment-intent-id}

payment_intent

always returned
Resource object representing payment_intent

Sample admin console URL

https://{site}.chargebee.com/admin-console/payment_intents/123x

Sample payment intent [ JSON ]

API Index URL

Model Class

Payment intent attributes

Consent Fields for Payment intent

Custom Fields for Payment intent

Create a payment intent ¶

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Update a payment intent ¶

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Retrieve a payment intent ¶

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL