[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

Parameters

  • amountinteger

    If the authorization’s pending_request.is_amount_controllable property is true, you may provide this value to control how much to hold for the authorization. Must be positive (use decline to decline an authorization request).

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns an approved Issuing Authorization object.

POST /v1/issuing/authorizations/:id/approve
curl -X POST https://api.stripe.com/v1/issuing/authorizations/iauth_1MvSKeLkdIwHu7ixKr8rO1HV/approve \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "iauth_1MvSKeLkdIwHu7ixKr8rO1HV",
"object": "issuing.authorization",
"amount": 0,
"amount_details": {
"atm_fee": null
},
"approved": true,
"authorization_method": "keyed_in",
"balance_transactions": [],
"card": {
"id": "ic_1MvSKeLkdIwHu7ixFANTvxgn",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681162380,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
},
"cardholder": null,
"created": 1681162380,
"currency": "usd",
"livemode": false,
"merchant_amount": 0,
"merchant_currency": "usd",
"merchant_data": {
"category": "taxicabs_limousines",
"category_code": "4121",
"city": "San Francisco",
"country": "US",
"name": "Rocket Rides",
"network_id": "1234567890",
"postal_code": "94107",
"state": "CA"
},
"metadata": {},
"network_data": null,
"pending_request": {
"amount": 700,
"amount_details": {
"atm_fee": null
},
"currency": "usd",
"is_amount_controllable": false,
"merchant_amount": 700,
"merchant_currency": "usd"
},
"request_history": [],
"status": "pending",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "match",
"cvc_check": "match",
"expiry_check": "match"
},
"wallet": null
}

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

Parameters

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns a declined Issuing Authorization object.

POST /v1/issuing/authorizations/:id/decline
curl -X POST https://api.stripe.com/v1/issuing/authorizations/iauth_1JVXl82eZvKYlo2CPIiWlzrn/decline \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"network_data": null,
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed",
"reason_message": null
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}

Create a test-mode authorization.

Parameters

  • amountintegerRequired

    The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card’s currency, and in the smallest currency unit.

  • cardstringRequired

    Card associated with this authorization.

  • currencyenum

    The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.

More parameters

  • amount_detailsobject

  • authorization_methodenum

  • fleetobject

  • fuelobject

  • is_amount_controllableboolean

  • merchant_dataobject

  • network_dataobject

  • verification_dataobject

  • walletenum

Returns

An Authorization object

POST /v1/test_helpers/issuing/authorizations
curl https://api.stripe.com/v1/test_helpers/issuing/authorizations \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d amount=1000 \
-d card=ic_1Nsse72eZvKYlo2CWBGm2WQ5
Response
{
"id": "iauth_1DPc772eZvKYlo2C6avLyZ25",
"object": "issuing.authorization",
"amount": 1000,
"amount_details": {
"atm_fee": null,
"cashback_amount": null
},
"approved": true,
"authorization_method": "keyed_in",
"balance_transactions": [],
"card": "ic_1Nsse72eZvKYlo2CWBGm2WQ5",
"cardholder": "ich_1Ccy6F2eZvKYlo2ClnIm9bs4",
"created": 1540586461,
"currency": "usd",
"livemode": false,
"merchant_amount": 0,
"merchant_currency": "usd",
"merchant_data": {
"category": "taxicabs_limousines",
"category_code": "4121",
"city": "San Francisco",
"country": "US",
"name": "Rocket Rides",
"network_id": "1234567890",
"postal_code": "94107",
"state": "CA",
"terminal_id": null
},
"metadata": {},
"network_data": null,
"pending_request": null,
"redaction": null,
"request_history": [],
"status": "reversed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "match",
"cvc_check": "match",
"expiry_check": "match"
},
"wallet": null
}

Capture a test-mode authorization.

Parameters

  • capture_amountinteger

    The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the smallest currency unit.

  • close_authorizationboolean

    Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.

  • purchase_detailsobject

    Additional purchase information that is optionally provided by the merchant.

Returns

An Authorization object.

POST /v1/test_helpers/issuing/authorizations/:id/capture
curl -X POST https://api.stripe.com/v1/test_helpers/issuing/authorizations/iauth_1DPc772eZvKYlo2C6avLyZ25/capture \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "iauth_1DPc772eZvKYlo2C6avLyZ25",
"object": "issuing.authorization",
"amount": 0,
"amount_details": {
"atm_fee": null,
"cashback_amount": null
},
"approved": true,
"authorization_method": "keyed_in",
"balance_transactions": [],
"card": {
"id": "ic_1FEiQC2eZvKYlo2CtahKepKy",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1Ccy6F2eZvKYlo2ClnIm9bs4",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Beverly Hills",
"country": "US",
"line1": "123 Fake St",
"line2": "Apt 3",
"postal_code": "90210",
"state": "CA"
}
},
"company": null,
"created": 1528992903,
"email": "jenny@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"preferred_locales": [],
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1567541772,
"currency": "usd",
"exp_month": 12,
"exp_year": 2020,
"last4": "4242",
"livemode": false,
"metadata": {
"status": "canceled"
},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "canceled",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_agreement"
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1Ccy6F2eZvKYlo2ClnIm9bs4",
"created": 1540586461,
"currency": "usd",
"livemode": false,
"merchant_amount": 0,
"merchant_currency": "usd",
"merchant_data": {
"category": "taxicabs_limousines",
"category_code": "4121",
"city": "San Francisco",
"country": "US",
"name": "Rocket Rides",
"network_id": "1234567890",
"postal_code": "94107",
"state": "CA",
"terminal_id": null
},
"metadata": {},
"network_data": null,
"pending_request": null,
"redaction": null,
"request_history": [],
"status": "reversed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "match",
"cvc_check": "match",
"expiry_check": "match"
},
"wallet": null
}

Expire a test-mode Authorization.

Parameters

No parameters.

Returns

An Authorization object

POST /v1/test_helpers/issuing/authorizations/:id/expire
curl -X POST https://api.stripe.com/v1/test_helpers/issuing/authorizations/iauth_1DPc772eZvKYlo2C6avLyZ25/expire \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "iauth_1DPc772eZvKYlo2C6avLyZ25",
"object": "issuing.authorization",
"amount": 0,
"amount_details": {
"atm_fee": null,
"cashback_amount": null
},
"approved": true,
"authorization_method": "keyed_in",
"balance_transactions": [],
"card": {
"id": "ic_1FEiQC2eZvKYlo2CtahKepKy",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1Ccy6F2eZvKYlo2ClnIm9bs4",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Beverly Hills",
"country": "US",
"line1": "123 Fake St",
"line2": "Apt 3",
"postal_code": "90210",
"state": "CA"
}
},
"company": null,
"created": 1528992903,
"email": "jenny@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"preferred_locales": [],
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1567541772,
"currency": "usd",
"exp_month": 12,
"exp_year": 2020,
"last4": "4242",
"livemode": false,
"metadata": {
"status": "canceled"
},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "canceled",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_agreement"
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1Ccy6F2eZvKYlo2ClnIm9bs4",
"created": 1540586461,
"currency": "usd",
"livemode": false,
"merchant_amount": 0,
"merchant_currency": "usd",
"merchant_data": {
"category": "taxicabs_limousines",
"category_code": "4121",
"city": "San Francisco",
"country": "US",
"name": "Rocket Rides",
"network_id": "1234567890",
"postal_code": "94107",
"state": "CA",
"terminal_id": null
},
"metadata": {},
"network_data": null,
"pending_request": null,
"redaction": null,
"request_history": [],
"status": "reversed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "match",
"cvc_check": "match",
"expiry_check": "match"
},
"wallet": null
}