Create a test-mode authorization Test helper

POST / v1 / test_helpers / issuing / authorizations

Create a test-mode authorization.

Parameters

card string Required Card associated with this authorization.
amount integer 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.
currency enum 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 _ details object
authorization _ method enum
fleet object
fuel object
is _ amount _ controllable boolean
merchant _ amount integer Preview feature
merchant _ currency enum Preview feature
merchant _ data object
network _ data object
verification _ data object
wallet enum

Returns

An Authorization object

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 Test helper

POST / v1 / test_helpers / issuing / authorizations /:id / capture

Capture a test-mode authorization.

Parameters

capture _ amount integer 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 _ authorization boolean Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
purchase _ details object Additional purchase information that is optionally provided by the merchant.

Returns

An Authorization object.

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 Test helper

POST / v1 / test_helpers / issuing / authorizations /:id / expire

Expire a test-mode Authorization.

Parameters

No parameters.

Returns

An Authorization object

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}