Get Checkout Attempt

GET

/api/:account_id/checkout-attempts/:checkout_attempt_id

GET

/api/:account_id/checkout-attempts/:checkout_attempt_id

$ curl https://app.paymentkit.com/api/account_id/checkout-attempts/checkout_attempt_id \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "string",
3   "checkout_session_id": "string",
4   "state": "string",
5   "created_at": "2024-01-15T09:30:00Z",
6   "updated_at": "2024-01-15T09:30:00Z",
7   "customer_id": "string",
8   "payment_intent_id": "string",
9   "cascade_tier": 0,
10   "error_code": "string",
11   "error_message_for_customer": "string",
12   "error_message_for_debug": "string",
13   "client_request_id": "string",
14   "submitted_customer_info": {},
15   "fraud_metadata": {},
16   "attempt_metadata": {},
17   "invoice_id": "string",
18   "subscription_id": "string",
19   "payment_method_id": "string",
20   "card_checkout_attempt_id": "string",
21   "card_checkout_attempt_state": "string",
22   "processor_attempts": [
23     {
24       "processor_id": "string",
25       "processor_name": "string",
26       "charge_status": "string",
27       "setup_status": "string",
28       "charge_error_message": "string",
29       "setup_error_message": "string",
30       "processor_attempt_id": "string",
31       "payment_method_id": "string",
32       "credential_source": "network_token",
33       "fallback_reason": "no_token",
34       "cryptogram_generated_at": "2024-01-15T09:30:00Z"
35     }
36   ],
37   "card_checkout_attempt": {
38     "id": "string",
39     "state": "string",
40     "user_actions_count": 1,
41     "max_user_actions_allowed": 1,
42     "created_at": "2024-01-15T09:30:00Z",
43     "updated_at": "2024-01-15T09:30:00Z",
44     "available_processors": [
45       "string"
46     ],
47     "card_checkout_settings": {},
48     "next_action_metadata": {},
49     "processor_attempts": [
50       {
51         "id": "string",
52         "charge_status": "string",
53         "setup_status": "string",
54         "processor_id": "string",
55         "processor_name": "string",
56         "charge_error_code": "string",
57         "charge_error_message": "string",
58         "setup_error_code": "string",
59         "setup_error_message": "string",
60         "processor_metadata": {},
61         "processor_attempt_id": "string",
62         "payment_method_id": "string",
63         "credential_source": "network_token",
64         "fallback_reason": "no_token",
65         "cryptogram_generated_at": "2024-01-15T09:30:00Z"
66       }
67     ],
68     "three_ds_mode": "string",
69     "three_ds_triggered": false,
70     "three_ds_outcome": "success"
71   },
72   "payment_method": {
73     "id": "string",
74     "account_id": "string",
75     "customer_id": "string",
76     "provider_type": "credit_card",
77     "name": "string",
78     "is_active": true,
79     "metadata": {},
80     "created_at": "2024-01-15T09:30:00Z",
81     "updated_at": "2024-01-15T09:30:00Z",
82     "used_in_subscription": false,
83     "network_token_status": "string"
84   },
85   "state_transitions": [
86     {
87       "id": "string",
88       "entity_type": "string",
89       "from_state": "string",
90       "to_state": "string",
91       "created_at": "2024-01-15T09:30:00Z",
92       "context": {}
93     }
94   ]
95 }

Get checkout attempt by ID.

Supports expand options:

processor_attempts: Include processor attempt summaries
card_checkout_attempt: Include full card checkout attempt with 3DS info
payment_method: Include payment method details
state_transitions: Include state transition history

Get checkout attempt by ID. Supports expand options: - processor_attempts: Include processor attempt summaries - card_checkout_attempt: Include full card checkout attempt with 3DS info - payment_method: Include payment method details - state_transitions: Include state transition history

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

checkout_attempt_idstringRequired

account_idstringRequired

Query parameters

expandlist of strings or nullOptional

Fields to expand: processor_attempts, card_checkout_attempt, payment_method, state_transitions

Response

Successful Response

idstring

checkout_session_idstring

statestring

created_atdatetime

updated_atdatetime

customer_idstring or nullOptional

payment_intent_idstring or nullOptional

cascade_tierintegerOptionalDefaults to 0

error_codestring or nullOptional

error_message_for_customerstring or nullOptional

error_message_for_debugstring or nullOptional

client_request_idstring or nullOptional

submitted_customer_infomap from strings to any or nullOptional

fraud_metadatamap from strings to any or nullOptional

attempt_metadatamap from strings to any or nullOptional

invoice_idstring or nullOptional

subscription_idstring or nullOptional

payment_method_idstring or nullOptional

card_checkout_attempt_idstring or nullOptional

card_checkout_attempt_statestring or nullOptional

processor_attemptslist of objects or nullOptional

card_checkout_attemptobject or nullOptional

Expanded card checkout attempt data.

payment_methodobject or nullOptional

Payment method API response model.

state_transitionslist of objects or nullOptional

Errors

422

Unprocessable Entity Error