Retrieve PaymentIntent

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Unique identifier for the payment intent object

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200成功

application/json

Body

code

string

required

msg

string

required

data

object

required

paymentIntentId

string

required

Unique identifier for the payment intent object.

clientReferenceId

string

自定义id

required

A client unique string

currency

string

币种

required

Three-letter ISO currency code, in upcase.

amount

number

金额

required

Payment amount

type

enum<string>

支付类型

required

Payment type, The default value is card

Allowed values:

cardpaypalstripe

paymentMethodId

string

支付方式id

optional

Payment method id

paymentMethodOptions

object

支付方式特殊配置

optional

Payment-method-specific configuration.

customerId

string

optional

The ID of the customer for this Session

created

integer

创建时间

required

Timestamp at which the object was created.

confirmAt

integer

完成时间

optional

Timestamp at which the payment was completed.

canceledAt

integer

取消时间

optional

Timestamp at which the payment was canceled

status

enum<string>

状态

required

Allowed values:

requires_payment_methodrequires_actionsucceededcanceled

amountRefunded

number

已退款金额

required

Amount refunded

latestCharge

object (Charge)

optional

the latest Charge object created by this PaymentIntent

Example

{
    "code": "string",
    "msg": "string",
    "data": {
        "paymentIntentId": "string",
        "clientReferenceId": "string",
        "currency": "string",
        "amount": 0,
        "type": "card",
        "paymentMethodId": "string",
        "paymentMethodOptions": {
            "card": {
                "setupFutureUsage": "on_session"
            }
        },
        "customerId": "string",
        "created": 0,
        "confirmAt": 0,
        "canceledAt": 0,
        "status": "requires_payment_method",
        "amountRefunded": 0,
        "latestCharge": {
            "chargeId": "string",
            "paymentIntentId": "string",
            "clientReferenceId": "string",
            "amount": 0,
            "currency": "string",
            "paymentMethodId": "string",
            "paymentMethodDetails": {
                "type": "card",
                "card": {
                    "email": "string",
                    "name": "string",
                    "country": "string",
                    "brand": "string",
                    "expYear": 0,
                    "expMonth": 0,
                    "front6": "string",
                    "last4": "string"
                }
            },
            "failureCode": "string",
            "failureMessage": "string",
            "status": "succeeded",
            "created": 0
        }
    }
}