{ "info": { "_postman_id": "f5a8e7b9-1a3b-463f-b402-f3ce42208c47", "name": "Spreedly API V1", "description": "An OpenAPI specification file for V1 of the Spreedly Core Transactional API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "lastUpdatedBy": "35240", "uid": "35240-f5a8e7b9-1a3b-463f-b402-f3ce42208c47" }, "item": [ { "name": "gateways", "item": [ { "name": "{gateway_token}", "item": [ { "name": "authorize", "item": [ { "name": "Authorize a payment method token", "id": "a72e0630-26bd-4fa4-a18e-85cb46c99952", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"transaction_metadata\": {},\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authenticated\": {\n \"sca_authentication_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/authorize", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "authorize" ], "variable": [ { "id": "2fa529b9-6dbd-4ce0-bfbb-183e3b8648c9", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Authorize a payment method to be charged a specific amount at the target gateway. No funds are taken with an authorize \u2013 a follow-up [capture](https://developer.spreedly.com/reference/capture-transaction) transaction is required to actually move the funds.\n\nThe referenced gateway must exist in the environment whose environment key is being used to authenticate the API call.\n\n**Tokenized payment method:** Authorize a Payment Method Token (already stored in the Spreedly environment) to be charged a specific amount.\n\nThe `payment_method_token` field of the transaction request is required.\n\n**Pass-in credit card:** Pass a credit card payment method directly in to the authorize request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `credit_card` field of the transaction request is required.\n\n**Pass-in Apple Pay:** Pass an Apple Pay payment method directly into the authorize request. If the Apple Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `apple_pay` field of the transaction request is required.\n\n**Pass-in Google Pay:** Pass a Google Pay payment method directly in to the authorize request. If the Google Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `google_pay` field of the transaction request is required.\n\n**SCA Authenticated:** Authorize an SCA Authenticated payment method (already stored in the Spreedly environment) to be charged a specific amount.\n\nThe `sca_authentication_token` field of the transaction request is required.\n" }, "response": [ { "id": "61c8a0f2-a2f4-464e-8196-ad3d292a3648", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"transaction_metadata\": {},\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authenticated\": {\n \"sca_authentication_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/authorize", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "authorize" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-61c8a0f2-a2f4-464e-8196-ad3d292a3648" }, { "id": "b7dc4ed0-76a6-4fa4-a735-5c911dfc8bdf", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"transaction_metadata\": {},\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authenticated\": {\n \"sca_authentication_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/authorize", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "authorize" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b7dc4ed0-76a6-4fa4-a735-5c911dfc8bdf" }, { "id": "16a9e5f2-719e-4516-ae1f-dee60f47ee35", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"transaction_metadata\": {},\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authenticated\": {\n \"sca_authentication_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/authorize", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "authorize" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-16a9e5f2-719e-4516-ae1f-dee60f47ee35" }, { "id": "902fd8d0-46b5-4792-b0e8-25b6a3c0b93c", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"transaction_metadata\": {},\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authenticated\": {\n \"sca_authentication_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/authorize", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "authorize" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-902fd8d0-46b5-4792-b0e8-25b6a3c0b93c" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a72e0630-26bd-4fa4-a18e-85cb46c99952" } ], "id": "283944d3-e8a6-4b28-b9ac-2b73b0761ac7", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-283944d3-e8a6-4b28-b9ac-2b73b0761ac7" }, { "name": "general_credit", "item": [ { "name": "Create a general credit transaction", "id": "47f2b439-6045-4331-8010-0221c4d2e0d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"continue_on_failure\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/general_credit", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "general_credit" ], "variable": [ { "id": "fa8280d8-3bc9-46aa-9aea-127e237dc36f", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Add funds to a credit card outside the scope of a previous reference transaction. This is different from [credit](https://developer.spreedly.com/reference/credit-transaction) which refunds money only up to the amount that had been taken during a previous transaction.\n\nSupport for general credit depends on the gateway.\n" }, "response": [ { "id": "0471d389-febc-42ff-84d2-5f31d3f3aa29", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"continue_on_failure\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/general_credit", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "general_credit" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0471d389-febc-42ff-84d2-5f31d3f3aa29" }, { "id": "c5c95857-51b6-4c0f-a06c-91b417a3cd06", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"continue_on_failure\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/general_credit", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "general_credit" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c5c95857-51b6-4c0f-a06c-91b417a3cd06" }, { "id": "8874f709-7ecc-4b5b-a9dc-86e9e1ec2923", "name": "Unprocessable entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"continue_on_failure\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/general_credit", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "general_credit" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-8874f709-7ecc-4b5b-a9dc-86e9e1ec2923" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-47f2b439-6045-4331-8010-0221c4d2e0d5" } ], "id": "001c1e1a-4038-4e3e-81d1-59794dac0bbc", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-001c1e1a-4038-4e3e-81d1-59794dac0bbc" }, { "name": "transactions.json", "item": [ { "name": "Transactions", "id": "4df624d0-6f43-4002-b0e2-134c7ca2fb6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/transactions.json?order=&since_token=&state=", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "transactions.json" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The transaction state on which to filter the returned list. Can be one of `succeeded`, `failed`, `gateway_processing_failed`, `gateway_processing_result_unknown`.", "key": "state", "value": "" } ], "variable": [ { "id": "fd89394e-818a-407e-9e3d-505c631a71e0", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Get an ordered and paginated list of transactions executed against a specific gateway." }, "response": [ { "id": "73c85b06-8b38-4544-b655-bc8a7b5366d7", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/transactions.json?order=&since_token=&state=", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "transactions.json" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The transaction state on which to filter the returned list. Can be one of `succeeded`, `failed`, `gateway_processing_failed`, `gateway_processing_result_unknown`.", "key": "state", "value": "" } ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-73c85b06-8b38-4544-b655-bc8a7b5366d7" }, { "id": "4b751b38-ce03-4a83-966d-dce988c21821", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/transactions.json?order=&since_token=&state=", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "transactions.json" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The transaction state on which to filter the returned list. Can be one of `succeeded`, `failed`, `gateway_processing_failed`, `gateway_processing_result_unknown`.", "key": "state", "value": "" } ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-4b751b38-ce03-4a83-966d-dce988c21821" }, { "id": "7c4a88d0-010a-4970-9a30-a9af700a6129", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/transactions.json?order=&since_token=&state=", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "transactions.json" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The transaction state on which to filter the returned list. Can be one of `succeeded`, `failed`, `gateway_processing_failed`, `gateway_processing_result_unknown`.", "key": "state", "value": "" } ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-7c4a88d0-010a-4970-9a30-a9af700a6129" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4df624d0-6f43-4002-b0e2-134c7ca2fb6d" } ], "id": "52ac01ed-76dd-434c-b85c-18103c6bdb0d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-52ac01ed-76dd-434c-b85c-18103c6bdb0d" }, { "name": "redact.json", "item": [ { "name": "Redact gateway", "id": "3a4f96fb-5303-4376-865a-b68a5ebf0c36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/redact.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "redact.json" ], "variable": [ { "id": "c87eb764-af3e-49f7-8176-99bc11ce37f5", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Redact (strip of any sensitive credentials and make inactive) a provisioned gateway." }, "response": [ { "id": "489e0258-0bb4-45c7-9b33-819248a304b9", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/redact.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "redact.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateway\": {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-489e0258-0bb4-45c7-9b33-819248a304b9" }, { "id": "ca74c7fb-69fe-4787-b671-df98140e976f", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/redact.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "redact.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ca74c7fb-69fe-4787-b671-df98140e976f" }, { "id": "fdc712e5-d5ae-41b1-a495-a516126053d0", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/redact.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "redact.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fdc712e5-d5ae-41b1-a495-a516126053d0" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3a4f96fb-5303-4376-865a-b68a5ebf0c36" } ], "id": "e3be0495-1fec-4d4e-9c6a-f65734547426", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-e3be0495-1fec-4d4e-9c6a-f65734547426" }, { "name": "retain.json", "item": [ { "name": "Retain gateway", "id": "8eddf123-a283-489a-87c6-16dde55791b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/retain.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "retain.json" ], "variable": [ { "id": "4e276a50-cec8-418a-aa03-28649c96266b", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "When gateways are created via the API, they are automatically retained. However, gateways created via the unauthenticated API (e.g., from a browser/javascript library) are created in the \u201ccached\u201d state. Only by retaining a cached gateway will it be saved and available for future use." }, "response": [ { "id": "24ed8011-139f-45d5-b2c8-6ddb34b84842", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/retain.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "retain.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateway\": {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-24ed8011-139f-45d5-b2c8-6ddb34b84842" }, { "id": "18aaf222-6ade-4624-8c1e-1613ffd2e7a1", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/retain.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "retain.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-18aaf222-6ade-4624-8c1e-1613ffd2e7a1" }, { "id": "fff9b2da-0bc2-4ceb-b442-06492f480e10", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/retain.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "retain.json" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fff9b2da-0bc2-4ceb-b442-06492f480e10" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8eddf123-a283-489a-87c6-16dde55791b4" } ], "id": "ba8477db-df6d-4a79-a595-a686285277e0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-ba8477db-df6d-4a79-a595-a686285277e0" }, { "name": "purchase", "item": [ { "name": "Create a purchase transaction", "id": "4f5c3c16-e600-40f8-844c-b1ae6c11f2f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "purchase" ], "variable": [ { "id": "6c96c551-ebed-4563-a122-24f5c2adcc39", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Charge a payment method a specific amount at the target gateway. One of the following payment methods must be included in the request:\n\n**Tokenized payment method:** Charge a _tokenized_ payment method (already stored in the Spreedly environment) the specified amount. The payment method can be of any type (credit card, bank account, Apple Pay, etc\u2026), as long as it exists in the specified environment.\n\nThe `payment_method_token` field of the transaction request is required.\n\n**Pass-in credit card:** Pass a credit card payment method directly in to the purchase request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `credit_card` field of the transaction request is required.\n\n**Pass-in bank account/ACH:** Pass a bank account/ACH payment method directly in to the purchase request. If the bank account is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `bank_account` field of the transaction request is required.\n\n**Pass-in Apple Pay:** Pass an Apple Pay payment method directly in to the purchase request. If the Apple Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `apple_pay` field of the transaction request is required.\n\n**Pass-in Google Pay:** Pass a Google Pay payment method directly in to the purchase request. If the Google Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `google_pay` field of the transaction request is required.\n\n**SCA Authenticated:** Charge an SCA Authenticated payment method (already stored in the Spreedly environment) the specified amount.\n\nThe `sca_authentication_token` field of the transaction request is required.\n" }, "response": [ { "id": "08de941e-80cf-483f-97a0-f9b7a7f6f7eb", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "purchase" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-08de941e-80cf-483f-97a0-f9b7a7f6f7eb" }, { "id": "3a0ba080-3b4b-4616-a61e-159575b64bd3", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "purchase" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3a0ba080-3b4b-4616-a61e-159575b64bd3" }, { "id": "457fcea3-ab2b-4529-96da-31720f6857d8", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "purchase" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-457fcea3-ab2b-4529-96da-31720f6857d8" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4f5c3c16-e600-40f8-844c-b1ae6c11f2f6" } ], "id": "fd99c20e-fb93-463a-be4c-5b1d394f21c1", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-fd99c20e-fb93-463a-be4c-5b1d394f21c1" }, { "name": "store", "item": [ { "name": "Create a store transaction", "id": "1250dcf3-8229-4d62-80c8-51f85b9bebf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"sub_merchant_key\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/store", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "store" ], "variable": [ { "id": "ecd87497-d1b0-4f35-a5bb-33ffd7f7a67b", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Tokenize a payment method *at the gateway*.\n\nThis transaction copies the payment method information from the Spreedly vault [to the gateway's vault](https://developer.spreedly.com/docs/third-party-vaulting) and creates a new Spreedly payment method to represent the gateway's version. The reference to the payment method at the gateway is called a ThirdPartyToken and is a separate payment method from the original payment method. It is up to you to manage the lifecycle of these linked payment methods \u2013 Spreedly does not keep them in sync in any way.\n\nThe ThirdPartyToken is locked to the gateway where the card is stored; it cannot be used at another gateway. If you'd like a card to be used at multiple gateways, you'll need to [retain the card in the Spreedly vault](https://developer.spreedly.com/docs/create-transactions#retain).\n" }, "response": [ { "id": "e3345b60-bafb-4b49-9989-305b99de3ef5", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"sub_merchant_key\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/store", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "store" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"created_at\": \"\",\n \"currency_code\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"token\": \"\",\n \"state\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_specific_response_fields\": {},\n \"transaction_type\": \"\",\n \"third_party_token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"gateway_latency_ms\": \"\",\n \"message_key\": \"\",\n \"message\": \"\",\n \"gateway_token\": \"\",\n \"gateway_type\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"gateway_type\": \"\",\n \"storage_state\": \"\",\n \"metadata\": {},\n \"third_party_token\": \"\",\n \"payment_method_type\": \"\"\n },\n \"basis_payment_method\": {},\n \"response\": {},\n \"sub_merchant_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e3345b60-bafb-4b49-9989-305b99de3ef5" }, { "id": "51235567-a8aa-4a2d-9625-180cbbff9400", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"sub_merchant_key\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/store", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "store" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-51235567-a8aa-4a2d-9625-180cbbff9400" }, { "id": "db7a68ac-7690-457d-b22d-0b7a8b05f721", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"sub_merchant_key\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/store", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "store" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-db7a68ac-7690-457d-b22d-0b7a8b05f721" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1250dcf3-8229-4d62-80c8-51f85b9bebf7" } ], "id": "b22c1cb0-7331-4f92-8625-4e74e1ca863d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b22c1cb0-7331-4f92-8625-4e74e1ca863d" }, { "name": "verify", "item": [ { "name": "Verify a payment method", "id": "14bd9a5c-2db8-4d3e-befd-f8133986211c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retain_on_success\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_authentication_token\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": \"\",\n \"gateway_specific_fields\": {},\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "verify" ], "variable": [ { "id": "596f5833-dda2-4ec2-9de7-ca5c4bf90463", "key": "gateway_token", "value": "", "description": "(Required) The token of the gateway to execute against" } ] }, "description": "Determine if a credit card is a [chargeable card and available for purchases](https://developer.spreedly.com/docs/using-payment-methods#verifying-a-card). The `retain_on_success` request parameter will automatically retain the card if it\u2019s successfully verified.\n\nAlso used by Ebanx Gateway customers as part of the enrollment process for Mercado Pago recurring payments. To learn more about this visit [Ebanx Gateway](https://developer.spreedly.com/docs/ebanx-gateway-guide).\n" }, "response": [ { "id": "57f170f1-c7cd-4ca7-bba1-c14b56ce791e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retain_on_success\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_authentication_token\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": \"\",\n \"gateway_specific_fields\": {},\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "verify" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"on_test_gateway\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"order_id\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_specific_response_fields\": {},\n \"gateway_transaction_id\": \"\",\n \"gateway_latency_ms\": \"\",\n \"currency_code\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"message_key\": \"\",\n \"message\": \"\",\n \"gateway_token\": \"\",\n \"gateway_type\": \"\",\n \"response\": {},\n \"shipping_address\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-57f170f1-c7cd-4ca7-bba1-c14b56ce791e" }, { "id": "cf3aa341-30ab-4000-aae8-9f5e06f033b3", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retain_on_success\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_authentication_token\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": \"\",\n \"gateway_specific_fields\": {},\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "verify" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cf3aa341-30ab-4000-aae8-9f5e06f033b3" }, { "id": "05ae15ef-de17-48b1-8367-295c7a32862a", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retain_on_success\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_authentication_token\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": \"\",\n \"gateway_specific_fields\": {},\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "verify" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-05ae15ef-de17-48b1-8367-295c7a32862a" }, { "id": "c35dcf58-8d7c-427c-a9d8-89fafadd678d", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Missing request parameter" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"retain_on_success\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_authentication_token\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": \"\",\n \"gateway_specific_fields\": {},\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/:gateway_token/verify", "host": [ "{{baseUrl}}" ], "path": [ "gateways", ":gateway_token", "verify" ], "variable": [ { "key": "gateway_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Missing request parameter" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.payment_method_or_payment_method_token_required\",\n \"message\": \"You must specify a valid 'payment_method' or valid 'payment_method_token' parameter.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n errors.payment_method_or_payment_method_token_required\\n You must specify a valid 'payment_method' or valid 'payment_method_token' parameter.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c35dcf58-8d7c-427c-a9d8-89fafadd678d" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-14bd9a5c-2db8-4d3e-befd-f8133986211c" } ], "id": "fca34c7b-ce10-49b9-969d-c5a08aa46d64", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-fca34c7b-ce10-49b9-969d-c5a08aa46d64" } ], "id": "df9e8433-1b04-415e-82bd-bc6eff18e0ac", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-df9e8433-1b04-415e-82bd-bc6eff18e0ac" }, { "name": "{gateway_token}.json", "item": [ { "name": "Show gateway", "id": "26ad0a1f-1706-4eca-9994-d6ed40199f2e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] }, "description": "Get a gateway with the given token." }, "response": [ { "id": "5c46c048-03ef-4f92-a487-7f317953410c", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateway\": {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5c46c048-03ef-4f92-a487-7f317953410c" }, { "id": "5ab13cd7-d0b2-44ed-9aa8-27f71ab23ad9", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5ab13cd7-d0b2-44ed-9aa8-27f71ab23ad9" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-26ad0a1f-1706-4eca-9994-d6ed40199f2e" }, { "name": "Update gateway", "id": "6f195673-49ef-48f9-bda6-57169148f3e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"credentials\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] }, "description": "Update a gateway.\n\nUpdate is intended to be used for updating credentials, description, or metadata.\n" }, "response": [ { "id": "6b594610-af04-41f6-a9d2-bc191841d475", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"credentials\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateway\": {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6b594610-af04-41f6-a9d2-bc191841d475" }, { "id": "44685e04-053b-4887-81a4-b46869faf53a", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"credentials\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-44685e04-053b-4887-81a4-b46869faf53a" }, { "id": "cec62ea3-b5bc-4a40-b9cd-8b8668e7ac95", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"credentials\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cec62ea3-b5bc-4a40-b9cd-8b8668e7ac95" }, { "id": "083dc42b-0b1c-4c0c-9305-36dd9bc92e3c", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"credentials\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways/{{gateway_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways", "{{gateway_token}}.json" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-083dc42b-0b1c-4c0c-9305-36dd9bc92e3c" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6f195673-49ef-48f9-bda6-57169148f3e9" } ], "id": "fd4ad063-582e-4e5d-810d-4d984bb5832d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-fd4ad063-582e-4e5d-810d-4d984bb5832d" } ], "id": "5ed38c3c-3c1d-4473-ae90-6fc8afbf5892", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-5ed38c3c-3c1d-4473-ae90-6fc8afbf5892" }, { "name": "transactions", "item": [ { "name": "{transaction_token}", "item": [ { "name": "capture", "item": [ { "name": "Capture full or partial transaction", "id": "6366acc8-d5e3-445e-8de6-406bd4f98eec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/capture", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "capture" ], "variable": [ { "id": "aad7cf1a-4626-40ba-a15a-f54df898a85f", "key": "transaction_token", "value": "", "description": "(Required) The token identifying the original authorize transaction." } ] }, "description": "Capture funds previously reserved via an authorize. By specifying an amount, you can capture a partial amount. If you omit the amount parameter, the full amount will be captured." }, "response": [ { "id": "25d0e54f-1f64-40e3-a1fe-b47be7e48ce4", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/capture", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "capture" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-25d0e54f-1f64-40e3-a1fe-b47be7e48ce4" }, { "id": "92e8e428-53d7-4ba3-8699-ec4050a6456b", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/capture", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "capture" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-92e8e428-53d7-4ba3-8699-ec4050a6456b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6366acc8-d5e3-445e-8de6-406bd4f98eec" } ], "id": "fb8c67f9-3da2-47bc-8f3c-42cc069e37c0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-fb8c67f9-3da2-47bc-8f3c-42cc069e37c0" }, { "name": "credit", "item": [ { "name": "Create a refund transaction", "id": "9351a503-9266-4cf0-b176-4a6acf878517", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/credit", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "credit" ], "variable": [ { "id": "b305cb54-04cd-472e-af8a-c005c242bdf9", "key": "transaction_token", "value": "", "description": "(Required) The token uniquely identifying this transaction (not the created payment method) at Spreedly." } ] }, "description": "Refund the full or partial amount of a purchase or capture. [Credit/Refund transactions](https://developer.spreedly.com/docs/create-transactions#payment-orchestration).\n" }, "response": [ { "id": "bab8d2ba-363b-4ba9-94b0-c21babaa62a5", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/credit", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "credit" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-bab8d2ba-363b-4ba9-94b0-c21babaa62a5" }, { "id": "dfcff430-ef56-433b-8595-7004dac83f78", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/credit", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "credit" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-dfcff430-ef56-433b-8595-7004dac83f78" }, { "id": "a9f46386-2319-4e78-83c7-3750acc6c098", "name": "Unprocessable entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/credit", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "credit" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a9f46386-2319-4e78-83c7-3750acc6c098" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-9351a503-9266-4cf0-b176-4a6acf878517" } ], "id": "a540e466-33a9-4550-ad1d-7df8e05466c3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a540e466-33a9-4550-ad1d-7df8e05466c3" }, { "name": "purchase", "item": [ { "name": "Create a purchase transaction via reference", "id": "d2e361ba-1522-4deb-a208-4ceb37f95ed2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"savings\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "purchase" ], "variable": [ { "id": "80f5914e-20b7-4752-b042-171fec2c1a6f", "key": "transaction_token", "value": "", "description": "(Required) The token uniquely identifying this transaction (not the created payment method) at Spreedly." } ] }, "description": "Execute a purchase using the payment method [utilized in a previous transaction](https://developer.spreedly.com/docs/using-payment-methods#reference-purchases).\n\nThe `currency_code` field is optional for this type of purchase request. It can be inferred from the referenced transaction.\n" }, "response": [ { "id": "363f7f92-0af2-464e-b1ec-2629d1304451", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"savings\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "purchase" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-363f7f92-0af2-464e-b1ec-2629d1304451" }, { "id": "381b1d04-3316-44b5-848a-971d90f56312", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"savings\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "purchase" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-381b1d04-3316-44b5-848a-971d90f56312" }, { "id": "5f64e46a-4a9b-48ad-8427-ad8f7997e946", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"savings\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "purchase" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5f64e46a-4a9b-48ad-8427-ad8f7997e946" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d2e361ba-1522-4deb-a208-4ceb37f95ed2" } ], "id": "ee7fa68d-bd3f-4bf6-9d72-807a2ac8f0e8", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-ee7fa68d-bd3f-4bf6-9d72-807a2ac8f0e8" }, { "name": "complete", "item": [ { "name": "Complete transaction", "id": "b4ccd867-43ae-40ce-a9fd-0664220fa38b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/complete", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "complete" ], "variable": [ { "id": "4caeef5f-ba50-46d3-a0d1-f29d02de3a0a", "key": "transaction_token", "value": "", "description": "(Required) The token of the transaction to complete" } ] }, "description": "Attempts to complete or advance a pending 3DS 2 transaction. We require merchants to make authenticated\ncalls to this endpoint in response to certain `Spreedly.ThreeDS.Lifecycle` events being emitted:\n\nA pending transaction with a `required_action` of `device_fingerprint` will fire a `trigger-completion`\nevent when the transaction status was updated due to a callback in the cardholder's iFrame or when 10\nseconds have elapsed. When this event is received, it is necessary to call `complete` so that the\nlatest transaction state can be retrieved in case of a timeout.\n\nA pending transaction with a `required_action` of `challenge` will fire a `finalization-timeout` when\nour `Spreedly.ThreeDS.Lifecycle` stops polling for updates after 10-15 minutes of not receiving a new\nstatus. When this event is received, it is recommended that merchants call `complete` so that the\ntransaction state can be updated due to cardholder abandonment or missed callbacks.\n\nPlease see our [3DS2 guides](https://developer.spreedly.com/docs/3ds-solutions) for more information and reference implementations.\n" }, "response": [ { "id": "3209de9c-3d08-48ae-a90f-13c60abd1509", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/complete", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "complete" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"required_action\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3209de9c-3d08-48ae-a90f-13c60abd1509" }, { "id": "728455b1-743f-4657-885e-e2d92829ad01", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/complete", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "complete" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-728455b1-743f-4657-885e-e2d92829ad01" }, { "id": "e614d757-ae6f-45af-8ef5-6d0f76b93e9f", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/complete", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "complete" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e614d757-ae6f-45af-8ef5-6d0f76b93e9f" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b4ccd867-43ae-40ce-a9fd-0664220fa38b" } ], "id": "f645482b-fed5-408d-9b1b-98537262679b", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f645482b-fed5-408d-9b1b-98537262679b" }, { "name": "confirm", "item": [ { "name": "Confirm transaction", "id": "d341f8b5-36a0-4f5e-96b6-53bc026508bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/confirm", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "confirm" ], "variable": [ { "id": "666cf5e4-2b68-4fbf-bca8-6745605501cf", "key": "transaction_token", "value": "", "description": "(Required) The token of the transaction to confirm" } ] }, "description": "Attempts to confirm a pending offsite purchase, offsite synchronous purchase or offsite synchronous authorization.\n\n**Braintree**\n A `processing` transaction with a `payment_method_type` of 'paypal' or 'venmo' is needed to confirm this transaction.\n [A object returned in iFrame](https://developer.spreedly.com/docs/braintree-gateway-guide#example-responses-for-callbackfunction). This could contain the following parameters; `state`, `nonce`, `payment_method`, `device_date`, `username`\n Please see our [Braintree APM section](https://developer.spreedly.com/docs/braintree-gateway-guide#alternative-payment-methods) for more information and reference implementations.\n\n**Stripe**\n For Stripe this offsite purchase is using APMs with a card payment.\n\n A pending transaction with a `payment_method` of type 'stripe_apm' is needed to confirm this transaction.\n A `payment_method_token` or credit card details in a `payment_method` object must be passed.\n Please see our [Stripe APM guide](https://developer.spreedly.com/docs/stripe-apm-offsite-payments) for more information and reference implementations.\n\nBIN metadata is available in the response if the card is enrolled in Advanced Vault. See [BIN metadata](https://developer.spreedly.com/docs/bin-metadata) for more information.\n" }, "response": [ { "id": "9dca2d96-8aaa-4914-86f0-6d00a1422fcc", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/confirm", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "confirm" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-9dca2d96-8aaa-4914-86f0-6d00a1422fcc" }, { "id": "1f17e55e-ea1f-4f89-9bf0-631318b655ee", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/confirm", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "confirm" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1f17e55e-ea1f-4f89-9bf0-631318b655ee" }, { "id": "cdb32ddb-d1dc-4951-b5d4-76dfc68d18dd", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/confirm", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "confirm" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cdb32ddb-d1dc-4951-b5d4-76dfc68d18dd" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d341f8b5-36a0-4f5e-96b6-53bc026508bd" } ], "id": "b535afe4-85ae-4a2b-9eb4-eab6737ff0f0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b535afe4-85ae-4a2b-9eb4-eab6737ff0f0" }, { "name": "transcript", "item": [ { "name": "Transaction transcript", "id": "6637d355-ce4f-4de8-b938-c2be1e98ef83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "should return a 200 response" } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/transcript", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "transcript" ], "variable": [ { "id": "53079686-8572-406f-869c-9b36d1ae8481", "key": "transaction_token", "value": "", "description": "(Required) The token identifying the transaction whose transcript is being requested" } ] }, "description": "View the exchange between Spreedly and the external service (gateway, receiver, etc\u2026)\nfor the given transaction in a human-readable, text format. The transcript is\nscrubbed of sensitive information so you can email it to external support\nrepresentatives to help in debugging and other support tasks.\n\nAs of December 31, 2022, Spreedly retains transaction transcripts for 90 days after\nthe initial date of the transaction. Transcript requests for transactions which are\nolder than 90 days will return a 404 http response.\n\nA transcript is not meant to be machine parseable and, as such, its format may\nchange at any time without warning.\n" }, "response": [ { "id": "6a10cc9f-7410-47af-9707-72ec6e441df1", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "should return a 200 response" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/transcript", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "transcript" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "should return a 200 response" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"text/plain\": {\n \"value\": \" [*>] POST to https://spreedly-echo.herokuapp.com\\n\\n Content-Type: application/json\\n X-App-Id: 1234\\n X-App-Secret: [FILTERED]\\n\\n {\\n \\\"product_id\\\":\\\"916593\\\",\\n \\\"card_number\\\":\\\"[FILTERED]\\\",\\n \\\"card_cvv\\\":\\\"[FILTERED]\\\",\\n \\\"first_name\\\":\\\"Newfirst\\\",\\n \\\"last_name\\\":\\\"Newlast\\\",\\n \\\"year\\\":\\\"2032\\\",\\n \\\"month\\\":\\\"3\\\"\\n }\\n\\n [<*] Response 200 received in 0s\\n\\n Date: Thu, 27 Jul 2017 17:55:48 GMT\\n Connection: close\\n Host: spreedly-echo.herokuapp.com\\n Accept: */*\\n User_agent: spreedly-agent/Typhoeus 0.6.9\\n X_request_id: e7473785-4070-4780-9e3a-66a84bbd2ca6\\n X_forwarded_for: 167.88.149.182\\n X_forwarded_proto: https\\n X_forwarded_port: 443\\n Via: 1.1 vegur, 1.1 vegur\\n Connect_time: 2\\n X_request_start: 1501178148676\\n Total_route_time: 0\\n X-Runtime: 0.000143\\n Server: thin 1.6.2 codename Doc Brown\\n\\n HOST: spreedly-echo.herokuapp.com\\n CONNECTION: close\\n ACCEPT: */*\\n USER_AGENT: spreedly-agent/Typhoeus 0.6.9\\n X_REQUEST_ID: e7473785-4070-4780-9e3a-66a84bbd2ca6\\n X_FORWARDED_FOR: 167.88.149.182\\n X_FORWARDED_PROTO: https\\n X_FORWARDED_PORT: 443\\n VIA: 1.1 vegur\\n CONNECT_TIME: 2\\n X_REQUEST_START: 1501178148676\\n TOTAL_ROUTE_TIME: 0\\n\\n {\\n \\\"product_id\\\":\\\"916593\\\",\\n \\\"card_number\\\":\\\"[FILTERED]\\\",\\n \\\"card_cvv\\\":\\\"\\\",\\n \\\"first_name\\\":\\\"Newfirst\\\",\\n \\\"last_name\\\":\\\"Newlast\\\",\\n \\\"year\\\":\\\"2032\\\",\\n \\\"month\\\":\\\"3\\\"\\n }\\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6a10cc9f-7410-47af-9707-72ec6e441df1" }, { "id": "a42510ce-1163-4fa0-9ab9-5f75ad5a7de1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/transcript", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "transcript" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a42510ce-1163-4fa0-9ab9-5f75ad5a7de1" }, { "id": "5f1a0674-c82a-4eb6-8587-049810792cc1", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/transcript", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "transcript" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5f1a0674-c82a-4eb6-8587-049810792cc1" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6637d355-ce4f-4de8-b938-c2be1e98ef83" } ], "id": "d0be6042-c1fa-4ab6-8104-edfaa8f07f79", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d0be6042-c1fa-4ab6-8104-edfaa8f07f79" }, { "name": "void", "item": [ { "name": "Void a transaction", "id": "54d06f26-b342-4854-8602-9eaafda0aa45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/void", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "void" ], "variable": [ { "id": "9e2ce6dc-7a44-4b6e-9ed9-7e2f5ea00c28", "key": "transaction_token", "value": "", "description": "(Required) The token uniquely identifying this transaction (not the created payment method) at Spreedly." } ] }, "description": "Cancel an `authorization` transaction or a `capture`/`purchase` transaction that hasn\u2019t yet settled at the merchant account.\n\nThis API call can also be used to cancel a `verify` transaction that was part of the Ebanx customer enrollment process. To learn more about this visit [Ebanx Gateway](https://developer.spreedly.com/docs/ebanx-gateway-guide).\n" }, "response": [ { "id": "520fff95-9b8c-485a-b040-f91cdf0a658f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/void", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "void" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"on_test_gateway\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": {},\n \"gateway_specific_response_fields\": {},\n \"gateway_transaction_id\": \"\",\n \"gateway_latency_ms\": \"\",\n \"message_key\": \"\",\n \"message\": \"\",\n \"gateway_token\": \"\",\n \"gateway_type\": \"\",\n \"response\": {},\n \"shipping_address\": {},\n \"reference_token\": {}\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-520fff95-9b8c-485a-b040-f91cdf0a658f" }, { "id": "fd58a652-8db6-45c9-bff5-209d084e4d09", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/void", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "void" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fd58a652-8db6-45c9-bff5-209d084e4d09" }, { "id": "b17b987d-2229-43e5-81f6-03afc35253c7", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/void", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "void" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b17b987d-2229-43e5-81f6-03afc35253c7" }, { "id": "18de511c-1913-44f5-ad69-26fc84cdf4fd", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token/void", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token", "void" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"ability\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"ability\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-18de511c-1913-44f5-ad69-26fc84cdf4fd" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-54d06f26-b342-4854-8602-9eaafda0aa45" } ], "id": "48b9ea74-f725-4570-b892-8216adb47967", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-48b9ea74-f725-4570-b892-8216adb47967" }, { "name": "Show transaction", "id": "85909c2c-bd38-47c3-8e24-c1d240b5274d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "id": "c986e069-7d51-4a61-846e-f6f541967c54", "key": "transaction_token", "value": "", "description": "(Required) The token of the transaction to execute against" } ] }, "description": "Get the transaction with the given token.\n\nAny interaction that creates or updates information via the Spreedly API,\nor sends information to a third party such as a gateway or receiver, will\ngenerate a corresponding transaction record that may be viewed by\nsubmitting its `transaction_token`. This may be viewable in the body of the\noriginal response or by retrieving it from the Transactions List in the\n[Spreedly app](https//app.spreedly.com).\n" }, "response": [ { "id": "65f2cdf2-b26a-41b9-854b-fb2730a97fdc", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-65f2cdf2-b26a-41b9-854b-fb2730a97fdc" }, { "id": "04625a5a-63cd-45e5-92ea-d00dd37f7685", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "Not authorized request" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-04625a5a-63cd-45e5-92ea-d00dd37f7685" }, { "id": "d75e4b0b-c796-4550-a681-db7279f55902", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "Token Not Found" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-d75e4b0b-c796-4550-a681-db7279f55902" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-85909c2c-bd38-47c3-8e24-c1d240b5274d" }, { "name": "Update transaction", "id": "c935c740-9c1f-43d7-8e70-227942299b65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "id": "5e22e0f1-db6e-4c19-98ef-bd2035792ace", "key": "transaction_token", "value": "", "description": "(Required) The token of the transaction to execute against" } ] }, "description": "Run an inquiry for a transaction's status at the gateway and update\nthe state of the Spreedly transaction with the given token. Only\nfor supported gateways. See our [syncing transactions guide](https://developer.spreedly.com/docs/syncing-your-gateway-transaction) for more information.\n" }, "response": [ { "id": "0c6e7d5e-8b42-41a2-a906-f812f685f4d1", "name": "Successful", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"original_transaction_updated\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0c6e7d5e-8b42-41a2-a906-f812f685f4d1" }, { "id": "b455de56-6fef-4b4f-808a-97547352e3a0", "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b455de56-6fef-4b4f-808a-97547352e3a0" }, { "id": "f1235f74-aa7d-48bc-a7e6-f310fc4db181", "name": "Not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f1235f74-aa7d-48bc-a7e6-f310fc4db181" }, { "id": "6b6254a4-e4b2-4ae9-9764-bdd789aaa836", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions/:transaction_token", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transaction_token" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"original_transaction_updated\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6b6254a4-e4b2-4ae9-9764-bdd789aaa836" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-c935c740-9c1f-43d7-8e70-227942299b65" } ], "id": "14212ffe-b437-4804-a31a-f7d187ed4b61", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-14212ffe-b437-4804-a31a-f7d187ed4b61" }, { "name": "authorize", "item": [ { "name": "Create an authorization with workflows", "id": "2db89205-fcd9-4460-92a3-939f3957d67c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/authorize", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "authorize" ] }, "description": "Spreedly's workflow service will determine which gateway the transaction will be processed based on the workflow evoked and send normalized fields depending on what the gateway supports. A `workflow_key` should be sent in the request body or left as null to evoke the Default Workflow set in your Spreedly environment.\n\nTo learn more about how to enable workflows, please contact Spreedly at support@spreedly.com.\n\nPass a credit card payment method directly into the authorize request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway. No funds are taken with an authorize - a follow-up capture transaction is required to actually move the funds.\n\n**Tokenized payment method:** Charge a _tokenized_ payment method (already stored in the Spreedly environment) the specified amount. The payment method can be of any type (credit card, bank account, Apple Pay, etc\u2026), as long as it exists in the specified environment.\n\nThe `payment_method_token` field of the transaction request is required.\n\n**Pass-in credit card:** Pass a credit card payment method directly in to the authorize request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `credit_card` field of the transaction request is required.\n\n**Pass-in Apple Pay:** Pass an Apple Pay payment method directly in to the authorize request. If the Apple Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `apple_pay` field of the transaction request is required.\n\n**Pass-in Google Pay:** Pass a Google Pay payment method directly in to the authorize request. If the Google Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `google_pay` field of the transaction request is required.\n\n**SCA Authenticated:** Charge an SCA Authenticated payment method (already stored in the Spreedly environment) the specified amount.\n\nThe `sca_authentication_token` field of the transaction request is required.\n\n**Default workflow:** Use the default workflow for the environment that is set in app.spreedly.com\n\nThe `workflow_key` field is not required to be passed in for this type of request.\n" }, "response": [ { "id": "6fcc5bf4-eb74-43a6-ba41-0d0780c3efc4", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/authorize", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "authorize" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6fcc5bf4-eb74-43a6-ba41-0d0780c3efc4" }, { "id": "61a06861-a811-4151-81e3-4de3bd6488cd", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/authorize", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "authorize" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-61a06861-a811-4151-81e3-4de3bd6488cd" }, { "id": "2b72c85c-1ce3-4f0c-b711-ed0bddf68ca5", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/authorize", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "authorize" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2b72c85c-1ce3-4f0c-b711-ed0bddf68ca5" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-2db89205-fcd9-4460-92a3-939f3957d67c" } ], "id": "18ab1a20-ce58-4d21-958d-cad3ad06b286", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-18ab1a20-ce58-4d21-958d-cad3ad06b286" }, { "name": "purchase", "item": [ { "name": "Create a purchase with workflows", "id": "270c9597-9bac-40dd-b71d-c998730fc40d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "purchase" ] }, "description": "Spreedly's workflow service will determine which gateway the transaction will be processed based on the workflow evoked and send normalized fields depending on what the gateway supports. A `workflow_key` should be sent in the request body or left as null to evoke the Default Workflow set in your Spreedly environment.\n\nTo learn more about how to enable workflows, please contact Spreedly at support@spreedly.com.\n\nCharge a payment method a specific amount at the target gateway. One of the following payment methods must be included in the request:\n\n**Tokenized payment method:** Charge a _tokenized_ payment method (already stored in the Spreedly environment) the specified amount. The payment method can be of any type (credit card, bank account, Apple Pay, etc\u2026), as long as it exists in the specified environment.\n\nThe `payment_method_token` field of the transaction request is required.\n\n**Pass-in credit card:** Pass a credit card payment method directly in to the purchase request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `credit_card` field of the transaction request is required.\n\n**Pass-in Apple Pay:** Pass an Apple Pay payment method directly in to the purchase request. If the Apple Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `apple_pay` field of the transaction request is required.\n\n**Pass-in Google Pay:** Pass a Google Pay payment method directly in to the purchase request. If the Google Pay data is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `google_pay` field of the transaction request is required.\n\n**SCA Authenticated:** Charge an SCA Authenticated payment method (already stored in the Spreedly environment) the specified amount.\n\nThe `sca_authentication_token` field of the transaction request is required.\n\n**Default workflow:** Use the default workflow for the environment that is set in app.spreedly.com\n\nThe `workflow_key` field is not required to be passed in for this type of request.\n" }, "response": [ { "id": "997a0541-cb07-4945-8a67-4dff1b3cadbc", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "purchase" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-997a0541-cb07-4945-8a67-4dff1b3cadbc" }, { "id": "630caafb-8b9e-4c60-84ea-38b97ad681fe", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "purchase" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-630caafb-8b9e-4c60-84ea-38b97ad681fe" }, { "id": "45546ff8-c63f-44c7-8382-fc6864d26d5b", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"attempt_network_token\": \"\",\n \"provision_network_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\",\n \"retry\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"mode\": \"\",\n \"custom_errors\": {\n \"error_codes\": [\n \"\",\n \"\"\n ],\n \"messages\": [\n \"\",\n \"\"\n ],\n \"additional_data\": [\n \"\",\n \"\"\n ],\n \"override_default_error_codes\": \"\"\n }\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/purchase", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "purchase" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-45546ff8-c63f-44c7-8382-fc6864d26d5b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-270c9597-9bac-40dd-b71d-c998730fc40d" } ], "id": "4448669f-a678-43fc-93bb-83b3431fd9ab", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4448669f-a678-43fc-93bb-83b3431fd9ab" }, { "name": "verify", "item": [ { "name": "Create a verify with workflows", "id": "8b5dfe07-7386-4b22-ad9a-9a19baf87187", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/verify", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "verify" ] }, "description": "Spreedly's workflow service will determine which gateway the transaction will be processed based on the workflow evoked and send normalized fields depending on what the gateway supports. A `workflow_key` should be sent in the request body or left as null to evoke the Default Workflow set in your Spreedly environment.\n\nTo learn more about how to enable workflows, please contact Spreedly at support@spreedly.com.\n\nDetermine if a credit card is chargeable card and available for purchases. The `retain_on_success` request parameter will automatically retain the card if it\u2019s successfully verified.\n\n**Tokenized payment method:** Charge a _tokenized_ payment method (already stored in the Spreedly environment) the specified amount. The payment method can be of any type (credit card, bank account, Apple Pay, etc\u2026), as long as it exists in the specified environment.\n\nThe `payment_method_token` field of the transaction request is required.\n\n**Pass-in credit card:** Pass a credit card payment method directly in to the verify request. If the card is valid, it will automatically be tokenized at Spreedly before sending to the gateway.\n\nThe `credit_card` field of the transaction request is required.\n\n**SCA Authenticated:** Charge an SCA Authenticated payment method (already stored in the Spreedly environment) the specified amount.\n\nThe `sca_authentication_token` field of the transaction request is required.\n\n**Default workflow:** Use the default workflow for the environment that is set in app.spreedly.com\n\nThe `workflow_key` field is not required to be passed in for this type of request.\n" }, "response": [ { "id": "c30f1936-48df-448c-a1d2-a297d0d02d57", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/verify", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"on_test_gateway\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"merchant_profile_key\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_specific_response_fields\": {},\n \"gateway_transaction_id\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"message_key\": \"\",\n \"message\": \"\",\n \"gateway_token\": \"\",\n \"gateway_type\": \"\",\n \"response\": {},\n \"shipping_address\": {},\n \"attempt_3dsecure\": \"\",\n \"payment_method\": {},\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c30f1936-48df-448c-a1d2-a297d0d02d57" }, { "id": "19a184b2-3709-4269-ae22-5268e1eeeca8", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/verify", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "verify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-19a184b2-3709-4269-ae22-5268e1eeeca8" }, { "id": "4b8e75bf-d033-40f0-963d-c80058ee48be", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"order_id\": \"\",\n \"description\": \"\",\n \"retain_on_success\": \"\",\n \"ip\": \"\",\n \"browser_info\": \"\",\n \"email\": \"\",\n \"gateway_specific_fields\": {},\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"sub_merchant_key\": \"\",\n \"sca_provider_key\": \"\",\n \"sca_authentication_parameters\": {\n \"three_ds_requestor_challenge_ind\": \"\",\n \"test_scenario\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\"\n },\n \"callback_url\": \"\",\n \"callback_format\": \"\",\n \"shipping_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"billing_address\": {\n \"name\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\"\n },\n \"ignore_failed_authentication_result\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"payment_method_token\": \"\",\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"personal\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"sca_authentication_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/verify", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "verify" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-4b8e75bf-d033-40f0-963d-c80058ee48be" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8b5dfe07-7386-4b22-ad9a-9a19baf87187" } ], "id": "c179c292-efc7-4344-b1ec-15bf4f943d3d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-c179c292-efc7-4344-b1ec-15bf4f943d3d" }, { "name": "List transactions", "id": "1cef5e56-c818-46b2-9bc1-aad3ff39c4da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?state=&count=&since_token=&order=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "The transaction state on which to filter the returned list. Can be one of succeeded, failed, gateway_processing_failed, gateway_processing_result_unknown.", "key": "state", "value": "" }, { "description": "The number of transactions to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.", "key": "order", "value": "" } ] }, "description": "Retrieve an [ordered and paginated](https://developer.spreedly.com/reference/order-and-pagination) list of all transactions in the authenticated environment.\n\nThis endpoint is [rate-limited](https://developer.spreedly.com/reference/response-codes#429-too-many-requests) to 30 requests per minute, per environment.\n" }, "response": [ { "id": "29cb1a42-f0af-49de-9b6f-1a5baa19ca3b", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions?state=&count=&since_token=&order=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "The transaction state on which to filter the returned list. Can be one of succeeded, failed, gateway_processing_failed, gateway_processing_result_unknown.", "key": "state", "value": "" }, { "description": "The number of transactions to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.", "key": "order", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-29cb1a42-f0af-49de-9b6f-1a5baa19ca3b" }, { "id": "17210ec5-913a-4552-9bf9-784436647f34", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/transactions?state=&count=&since_token=&order=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "The transaction state on which to filter the returned list. Can be one of succeeded, failed, gateway_processing_failed, gateway_processing_result_unknown.", "key": "state", "value": "" }, { "description": "The number of transactions to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.", "key": "order", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-17210ec5-913a-4552-9bf9-784436647f34" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1cef5e56-c818-46b2-9bc1-aad3ff39c4da" } ], "id": "18bcd972-2352-404f-80ae-b736b0e509ec", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-18bcd972-2352-404f-80ae-b736b0e509ec" }, { "name": "card_refresher", "item": [ { "name": "inquiry", "item": [ { "name": "{token}", "item": [ { "name": "Show inquiry", "id": "c1c330ce-d349-4168-8108-4a8c8db80106", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiry/:token", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry", ":token" ], "variable": [ { "id": "01d6fae1-2510-4bd3-a3e5-0f8dd91f6266", "key": "token", "value": "", "description": "(Required) The token of the inquiry" } ] }, "description": "Get an inquiry with the given token." }, "response": [ { "id": "25b68550-8f38-44c3-81d1-b72ba5583fb4", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiry/:token", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry", ":token" ], "variable": [ { "key": "token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"inquiry\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"state\": \"\",\n \"transaction_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"region\": \"\",\n \"inquiry_status\": \"\",\n \"payment_method_token\": \"\",\n \"card_refresh_event\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"environment_key\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-25b68550-8f38-44c3-81d1-b72ba5583fb4" }, { "id": "cd311a92-6969-4cf9-ac97-7d8fbde3c82a", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiry/:token", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry", ":token" ], "variable": [ { "key": "token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cd311a92-6969-4cf9-ac97-7d8fbde3c82a" }, { "id": "89ee65ad-bcd6-44d9-af8a-e789109fe7ce", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiry/:token", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry", ":token" ], "variable": [ { "key": "token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-89ee65ad-bcd6-44d9-af8a-e789109fe7ce" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-c1c330ce-d349-4168-8108-4a8c8db80106" } ], "id": "7d5034de-9da3-4292-8b15-626813ff4f22", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7d5034de-9da3-4292-8b15-626813ff4f22" }, { "name": "Card Refresher Inquiry", "id": "f1d16b6d-ed62-4754-b163-bfbd9dceb8a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"card_refresher_inquiry\": {\n \"payment_method_token\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_refresher/inquiry", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry" ] }, "description": "Make an inquiry to a card network (currently Visa) to get any applicable updates for the card." }, "response": [ { "id": "36ae3757-71a9-441f-b68c-1a586efff530", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"card_refresher_inquiry\": {\n \"payment_method_token\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_refresher/inquiry", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"state\": \"\",\n \"transaction_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"region\": \"\",\n \"inquiry_status\": \"\",\n \"payment_method_token\": \"\",\n \"card_refresh_transaction\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"environment_key\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-36ae3757-71a9-441f-b68c-1a586efff530" }, { "id": "21c5074c-0ebe-44e3-9ade-202957d7ed48", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"card_refresher_inquiry\": {\n \"payment_method_token\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_refresher/inquiry", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-21c5074c-0ebe-44e3-9ade-202957d7ed48" }, { "id": "82514424-316e-402e-a375-4ff8d77fead7", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"card_refresher_inquiry\": {\n \"payment_method_token\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_refresher/inquiry", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-82514424-316e-402e-a375-4ff8d77fead7" }, { "id": "733639ab-d533-4ee7-b5e3-a24e7d0a9cae", "name": "Not Processable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Ineligible card for inquiry" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"card_refresher_inquiry\": {\n \"payment_method_token\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_refresher/inquiry", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiry" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-733639ab-d533-4ee7-b5e3-a24e7d0a9cae" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f1d16b6d-ed62-4754-b163-bfbd9dceb8a2" } ], "id": "0230f5fb-e07a-447b-a68f-933f53c22d64", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-0230f5fb-e07a-447b-a68f-933f53c22d64" }, { "name": "inquiries", "item": [ { "name": "List inquiries", "id": "62be02d4-7f7b-44b9-8888-14d6aa95a8b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiries?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiries" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of inquiries to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] }, "description": "Retrieve an [ordered and paginated](https://developer.spreedly.com/reference/order-and-pagination) list of all inquiries in the environment" }, "response": [ { "id": "1d5145de-7992-4788-a866-7a4fda3f2738", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiries?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiries" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of inquiries to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"inquiries\": [\n {\n \"inquiry\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"state\": \"\",\n \"transaction_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"region\": \"\",\n \"inquiry_status\": \"\",\n \"payment_method_token\": \"\",\n \"card_refresh_event\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"environment_key\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n }\n },\n {\n \"inquiry\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"state\": \"\",\n \"transaction_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"region\": \"\",\n \"inquiry_status\": \"\",\n \"payment_method_token\": \"\",\n \"card_refresh_event\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"environment_key\": \"\",\n \"region\": \"\",\n \"updating_service\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1d5145de-7992-4788-a866-7a4fda3f2738" }, { "id": "514e3081-05a4-40de-97a5-d4738b127e19", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiries?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiries" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of inquiries to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-514e3081-05a4-40de-97a5-d4738b127e19" }, { "id": "1c001c1b-42ae-4416-8bd8-c76ed6f6ef1a", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/card_refresher/inquiries?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "card_refresher", "inquiries" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of inquiries to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1c001c1b-42ae-4416-8bd8-c76ed6f6ef1a" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-62be02d4-7f7b-44b9-8888-14d6aa95a8b8" } ], "id": "1f05eeb5-238c-4bfa-98e1-0b955319c132", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1f05eeb5-238c-4bfa-98e1-0b955319c132" } ], "id": "6019b116-98c4-46bb-8fd2-16fafff1bd6c", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6019b116-98c4-46bb-8fd2-16fafff1bd6c" }, { "name": "certificates", "item": [ { "name": "generate", "item": [ { "name": "Generate a certificate", "id": "7a359250-b020-4100-9720-0836927541f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/generate", "host": [ "{{baseUrl}}" ], "path": [ "certificates", "generate" ] }, "description": "Generate a new SSL keypair and certificate signing request (CSR). Since Spreedly is not a certificate authority we cannot issue trusted certificates. Instead, it is intended that you will get the certificate signed by your certificate authority (or sign it yourself) and update the certificate record at Spreedly with the final and signed cert." }, "response": [ { "id": "b536fc6a-3aab-4cf0-a350-704bd8de06b2", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/generate", "host": [ "{{baseUrl}}" ], "path": [ "certificates", "generate" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"certificate\": {\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\",\n \"public_key\": \"\",\n \"public_key_hash\": \"\",\n \"csr\": \"\",\n \"pem\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b536fc6a-3aab-4cf0-a350-704bd8de06b2" }, { "id": "63ef3a51-a060-48fc-8a15-b7adfa446a74", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/generate", "host": [ "{{baseUrl}}" ], "path": [ "certificates", "generate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-63ef3a51-a060-48fc-8a15-b7adfa446a74" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7a359250-b020-4100-9720-0836927541f3" } ], "id": "77cd93de-624d-427f-aac5-738fe10475cb", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-77cd93de-624d-427f-aac5-738fe10475cb" }, { "name": "{certificate_token}", "item": [ { "name": "Update certificate", "id": "d94a8e9d-37e6-4f92-9402-7f1550bbc3fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/:certificate_token", "host": [ "{{baseUrl}}" ], "path": [ "certificates", ":certificate_token" ], "variable": [ { "id": "b6a3a530-81b7-42e4-add7-4244156a1289", "key": "certificate_token", "value": "", "description": "(Required) A unique string generated by Spreedly to identify a certificate." } ] }, "description": "Update an existing SSL certificate record with the signed certificate value (in PEM format)." }, "response": [ { "id": "5f280da5-14da-4418-a20f-7381b358c418", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/:certificate_token", "host": [ "{{baseUrl}}" ], "path": [ "certificates", ":certificate_token" ], "variable": [ { "key": "certificate_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"certificate\": {\n \"token\": \"\",\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\",\n \"public_key\": \"\",\n \"public_key_hash\": \"\",\n \"csr\": \"\",\n \"pem\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5f280da5-14da-4418-a20f-7381b358c418" }, { "id": "035dc925-4a5c-4d10-991f-0094bd9fd97d", "name": "Request not processed", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates/:certificate_token", "host": [ "{{baseUrl}}" ], "path": [ "certificates", ":certificate_token" ], "variable": [ { "key": "certificate_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-035dc925-4a5c-4d10-991f-0094bd9fd97d" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d94a8e9d-37e6-4f92-9402-7f1550bbc3fa" } ], "id": "416d7515-9fcf-4c1a-866d-503626f14d5a", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-416d7515-9fcf-4c1a-866d-503626f14d5a" }, { "name": "List certificates", "id": "39413df3-9050-47a4-b68c-83ec4a468464", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/certificates?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous page if iterating through records).", "key": "since_token", "value": "" } ] }, "description": "Retrieve an [ordered and paginated](https://developer.spreedly.com/reference/order-and-pagination) list of all certificates in the authenticated environment." }, "response": [ { "id": "d81f15d1-9dc7-4a11-ae7e-a142940eb665", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/certificates?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous page if iterating through records).", "key": "since_token", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"certificates\": [\n {\n \"token\": \"\",\n \"level\": \"\",\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\",\n \"public_key\": \"\",\n \"public_key_hash\": \"\",\n \"csr\": \"\",\n \"pem\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"token\": \"\",\n \"level\": \"\",\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\",\n \"public_key\": \"\",\n \"public_key_hash\": \"\",\n \"csr\": \"\",\n \"pem\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-d81f15d1-9dc7-4a11-ae7e-a142940eb665" }, { "id": "828421a7-e3cf-4e83-9897-255022607c94", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/certificates?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous page if iterating through records).", "key": "since_token", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-828421a7-e3cf-4e83-9897-255022607c94" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-39413df3-9050-47a4-b68c-83ec4a468464" }, { "name": "Create a certificate", "id": "1109b936-9d98-4526-91cd-fa75bf05d8a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\",\n \"private_key\": \"\",\n \"level\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ] }, "description": "Add a certificate to the authenticated environment for use in [secure payment method tokenization](https://developer.spreedly.com/docs/iframe-api-lifecycle#security-requirements), payment method distribution functions such as [XML digital signatures](https://developer.spreedly.com/reference/order-and-pagination), or to utilize [Apple Pay](https://developer.spreedly.com/docs/apple-pay#generate-certificate)." }, "response": [ { "id": "eafc96e6-3842-4430-a83f-2fc2daec3c09", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\",\n \"private_key\": \"\",\n \"level\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"certificate\": {\n \"token\": \"\",\n \"algorithm\": \"\",\n \"cn\": \"\",\n \"o\": \"\",\n \"ou\": \"\",\n \"c\": \"\",\n \"st\": \"\",\n \"l\": \"\",\n \"email_address\": \"\",\n \"public_key\": \"\",\n \"public_key_hash\": \"\",\n \"csr\": \"\",\n \"pem\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-eafc96e6-3842-4430-a83f-2fc2daec3c09" }, { "id": "c578a06b-fdc9-4d2a-b3cc-bdf33dde339e", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\",\n \"private_key\": \"\",\n \"level\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c578a06b-fdc9-4d2a-b3cc-bdf33dde339e" }, { "id": "a9bfc413-5f46-4a3e-9a7f-b254280cbdc8", "name": "Request not processed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificate\": {\n \"pem\": \"\",\n \"private_key\": \"\",\n \"level\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/certificates", "host": [ "{{baseUrl}}" ], "path": [ "certificates" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a9bfc413-5f46-4a3e-9a7f-b254280cbdc8" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1109b936-9d98-4526-91cd-fa75bf05d8a7" } ], "id": "f22ac12f-5b43-4a8e-bf12-c3fd56aa7ef4", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f22ac12f-5b43-4a8e-bf12-c3fd56aa7ef4" }, { "name": "environments", "item": [ { "name": "{environment_key}", "item": [ { "name": "access_secrets", "item": [ { "name": "{access_secret_key}", "item": [ { "name": "Show environment access secret", "id": "585b6171-e7b5-462d-8ce7-38b8a4a77295", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "id": "236b6462-1b6f-4a58-a1d8-50feaa20468b", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" }, { "id": "aeb8bd70-2bc7-4927-b79c-94aba511b03b", "key": "access_secret_key", "value": "", "description": "(Required) The key of the access secret to execute against" } ] }, "description": "Get an access secret with the given key. This call should be authenticated with the key of the environment that you are accessing and an Organization Access Secret." }, "response": [ { "id": "31ad1170-cb64-45d3-a896-955df5726bf2", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access_secret\": {\n \"key\": \"\",\n \"environment\": \"\",\n \"name\": \"\",\n \"access_secret\": \"\",\n \"created_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-31ad1170-cb64-45d3-a896-955df5726bf2" }, { "id": "68a26dbd-2820-4ee2-b8d0-ac7b1435f25d", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-68a26dbd-2820-4ee2-b8d0-ac7b1435f25d" }, { "id": "42471745-f6d0-44b1-9c7f-68a367f00448", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-42471745-f6d0-44b1-9c7f-68a367f00448" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-585b6171-e7b5-462d-8ce7-38b8a4a77295" }, { "name": "Delete environment access secret", "id": "256a59e7-475d-48a5-8f04-488fa32f8bd1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "id": "b4563f5d-66f4-4017-a380-b8ae3100518a", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" }, { "id": "13fc7366-23a7-4941-a370-737a61d21cd5", "key": "access_secret_key", "value": "", "description": "(Required) The key of the access secret to execute against" } ] }, "description": "Delete an access secret in an environment. Authentication should be done using the environment where you want to delete the secret and an Organization Access Secret." }, "response": [ { "id": "b405dd82-afae-4a53-97e1-8a70b13e68fc", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b405dd82-afae-4a53-97e1-8a70b13e68fc" }, { "id": "13446596-b20f-4f8a-8b28-1ecae3f303f9", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-13446596-b20f-4f8a-8b28-1ecae3f303f9" }, { "id": "9cd7442e-3b25-4d43-9e6c-433eb660d217", "name": "Not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets/:access_secret_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets", ":access_secret_key" ], "variable": [ { "key": "environment_key" }, { "key": "access_secret_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-9cd7442e-3b25-4d43-9e6c-433eb660d217" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-256a59e7-475d-48a5-8f04-488fa32f8bd1" } ], "id": "e3a2f477-ee98-4a47-997b-6f1cab226949", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-e3a2f477-ee98-4a47-997b-6f1cab226949" }, { "name": "Create environment access secret", "id": "303927db-8630-419e-bafc-58c4ec780c1a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"access_secret\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "id": "71d158ba-fc1e-453e-8ad4-109d50a6c185", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" } ] }, "description": "Create an access secret in an environment. Authentication should be done using the environment where you want to create the secret and an Organization Access Secret." }, "response": [ { "id": "66d157f4-225a-4425-9e27-6ade91850970", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"access_secret\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access_secret\": {\n \"key\": \"\",\n \"environment\": \"\",\n \"name\": \"\",\n \"access_secret\": \"\",\n \"created_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-66d157f4-225a-4425-9e27-6ade91850970" }, { "id": "e2130a11-2f1d-4b36-a821-4493712380f0", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"access_secret\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e2130a11-2f1d-4b36-a821-4493712380f0" }, { "id": "c4705425-02a6-4eaa-a484-5d2b04857e31", "name": "Unprocessable entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"access_secret\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c4705425-02a6-4eaa-a484-5d2b04857e31" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-303927db-8630-419e-bafc-58c4ec780c1a" }, { "name": "List environment access secrets", "id": "4a05c9fc-b6b8-4807-a85a-aaf8053f3c97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "id": "b35e1af7-c630-4e20-b658-a17f8963bb61", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" } ] }, "description": "Retrieve a list of all access secrets in an environment. This call should be authenticated with the key of the environment that you are accessing and an Organization Access Secret." }, "response": [ { "id": "e62f976c-4944-4a42-9044-2b6d9a3e7de9", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access_secrets\": [\n {\n \"key\": \"\",\n \"environment\": \"\",\n \"name\": \"\",\n \"access_secret\": \"\",\n \"created_at\": \"\"\n },\n {\n \"key\": \"\",\n \"environment\": \"\",\n \"name\": \"\",\n \"access_secret\": \"\",\n \"created_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e62f976c-4944-4a42-9044-2b6d9a3e7de9" }, { "id": "1ade2e60-5343-4981-bbf1-ce6de0f0e5ab", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1ade2e60-5343-4981-bbf1-ce6de0f0e5ab" }, { "id": "cc63c5b5-0abc-42b9-8be4-e1d75fb1406a", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/access_secrets", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "access_secrets" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cc63c5b5-0abc-42b9-8be4-e1d75fb1406a" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4a05c9fc-b6b8-4807-a85a-aaf8053f3c97" } ], "id": "3e09aeca-a14c-43c3-a885-5b3416adf9be", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3e09aeca-a14c-43c3-a885-5b3416adf9be" }, { "name": "regenerate_signing_secret", "item": [ { "name": "Regenerate signing secret", "id": "03df338c-fb52-4d3d-95cf-dddbb6e5cd04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/regenerate_signing_secret", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "regenerate_signing_secret" ], "variable": [ { "id": "86df631a-4b3c-4a60-b889-a754243f2554", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" } ] }, "description": "Regenerate environment signing secret. Once this is regenerated, the old signing secret will no longer be valid and you must immediately update your application with the new signing secret. This call should be authenticated with the key of the environment that you are trying to update and an Organization Access Secret." }, "response": [ { "id": "22f1547a-39e5-41bb-872a-981d47ca9ce7", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/regenerate_signing_secret", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "regenerate_signing_secret" ], "variable": [ { "key": "environment_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"environment\": {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-22f1547a-39e5-41bb-872a-981d47ca9ce7" }, { "id": "506434da-902c-4977-b756-6697f0cb901c", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key/regenerate_signing_secret", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key", "regenerate_signing_secret" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-506434da-902c-4977-b756-6697f0cb901c" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-03df338c-fb52-4d3d-95cf-dddbb6e5cd04" } ], "id": "70d064bd-118e-434c-8c54-212083eb74af", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-70d064bd-118e-434c-8c54-212083eb74af" }, { "name": "Show environment", "id": "32ea55c3-7729-4c53-aceb-717e508a72f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "id": "40353ede-c5f3-4ca8-aa29-7d64dd4a2502", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" } ] }, "description": "Get an environment with the given key. This call should be authenticated with the key of the environment that you are trying to show and an Organization Access Secret." }, "response": [ { "id": "272fd7a6-5796-4e70-8274-7719dd1d6f3c", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "key": "environment_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"environment\": {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-272fd7a6-5796-4e70-8274-7719dd1d6f3c" }, { "id": "7295fa6a-1c94-4c80-b0cd-e5103d988fe2", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-7295fa6a-1c94-4c80-b0cd-e5103d988fe2" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-32ea55c3-7729-4c53-aceb-717e508a72f9" }, { "name": "Update environment", "id": "a712f864-3ffb-4618-aaf6-b21503603dcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"smart_routing_enabled\": \"\",\n \"default_gateway_token\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "id": "a9dd48d9-504e-47d1-85b7-c9edaeafa226", "key": "environment_key", "value": "", "description": "(Required) The key of the environment to execute against" } ] }, "description": "Update an existing environment. This call should be authenticated with the key of the environment that you are trying to update and an Organization Access Secret." }, "response": [ { "id": "834ba9ef-b70d-475c-ac47-cfec83778a94", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"smart_routing_enabled\": \"\",\n \"default_gateway_token\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "key": "environment_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"environment\": {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-834ba9ef-b70d-475c-ac47-cfec83778a94" }, { "id": "4b1910f0-f337-42c1-8c17-bc8694035b20", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"smart_routing_enabled\": \"\",\n \"default_gateway_token\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-4b1910f0-f337-42c1-8c17-bc8694035b20" }, { "id": "070f48a8-b952-466f-bd74-2a8474e96974", "name": "Unprocessable entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"smart_routing_enabled\": \"\",\n \"default_gateway_token\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments/:environment_key", "host": [ "{{baseUrl}}" ], "path": [ "environments", ":environment_key" ], "variable": [ { "key": "environment_key" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-070f48a8-b952-466f-bd74-2a8474e96974" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a712f864-3ffb-4618-aaf6-b21503603dcf" } ], "id": "cf9d1de9-73db-4838-80ad-3a40284b962c", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-cf9d1de9-73db-4838-80ad-3a40284b962c" }, { "name": "List environments", "id": "3c6420fd-3018-4d76-88c7-4d645d4790cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/environments?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "environments" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "Token refers to the key of the environment to start from (e.g., the last environment_key received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of environments to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all environments in an organization. This call should be authenticated with an environment key from the organization and an Organization Access Secret." }, "response": [ { "id": "23b769ef-1321-430c-a7c6-2e495b86783d", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "environments" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "Token refers to the key of the environment to start from (e.g., the last environment_key received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of environments to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"environments\": [\n {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n },\n {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-23b769ef-1321-430c-a7c6-2e495b86783d" }, { "id": "11943d2f-4268-45f3-b3cf-5b79fb5db94d", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/environments?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "environments" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "Token refers to the key of the environment to start from (e.g., the last environment_key received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of environments to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-11943d2f-4268-45f3-b3cf-5b79fb5db94d" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3c6420fd-3018-4d76-88c7-4d645d4790cf" }, { "name": "Create an environment", "id": "f737a80a-77eb-4768-a66b-2e4ffb8121ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments", "host": [ "{{baseUrl}}" ], "path": [ "environments" ] }, "description": "Create an environment in your organization. You will need to create one environment and access secret manually at app.spreedly.com for authentication. After that you can authenticate the API call using that environment key and an Organization Access Secret." }, "response": [ { "id": "0cb5c1eb-fa09-4873-bf01-6eb300ea00c4", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments", "host": [ "{{baseUrl}}" ], "path": [ "environments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"environment\": {\n \"key\": \"\",\n \"signing_secret\": \"\",\n \"organization_key\": \"\",\n \"callback_url\": \"\",\n \"smart_routing_enabled\": \"\",\n \"allow_direct_api_payment_method_creation\": \"\",\n \"name\": \"\",\n \"default_gateway_token\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"au_enabled\": \"\",\n \"retry\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0cb5c1eb-fa09-4873-bf01-6eb300ea00c4" }, { "id": "12bddb17-26ab-4282-a421-e8dbe2801317", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments", "host": [ "{{baseUrl}}" ], "path": [ "environments" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-12bddb17-26ab-4282-a421-e8dbe2801317" }, { "id": "e0f98bed-d8ec-4121-8b7c-ba89c995972b", "name": "Unprocessable entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"environment\": {\n \"name\": \"\",\n \"callback_url\": \"\",\n \"allow_direct_api_method_creation\": \"\",\n \"au_enabled\": \"\",\n \"payment_method_management_enabled\": \"\",\n \"iframe_enhanced_security_enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/environments", "host": [ "{{baseUrl}}" ], "path": [ "environments" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e0f98bed-d8ec-4121-8b7c-ba89c995972b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f737a80a-77eb-4768-a66b-2e4ffb8121ea" } ], "id": "7a6a34e3-7fb8-4907-bbdd-12618f265ca9", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7a6a34e3-7fb8-4907-bbdd-12618f265ca9" }, { "name": "events", "item": [ { "name": "{event_id}", "item": [ { "name": "Show event", "id": "46230538-5817-457f-ad56-041192566ff1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/events/:event_id", "host": [ "{{baseUrl}}" ], "path": [ "events", ":event_id" ], "variable": [ { "id": "fac4ad4a-3143-4a5e-8732-b0a890c00166", "key": "event_id", "value": "", "description": "(Required) The id of the event" } ] }, "description": "Get an event with the given id." }, "response": [ { "id": "776999fc-9a2f-4d83-8cf3-d3af0fd01d4f", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events/:event_id", "host": [ "{{baseUrl}}" ], "path": [ "events", ":event_id" ], "variable": [ { "key": "event_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"event\": {\n \"id\": \"\",\n \"request_id\": \"\",\n \"event_type\": \"\",\n \"object_type\": \"\",\n \"object_key\": \"\",\n \"created_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-776999fc-9a2f-4d83-8cf3-d3af0fd01d4f" }, { "id": "56b07c4e-2666-454d-b45d-a4c6aa49309d", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events/:event_id", "host": [ "{{baseUrl}}" ], "path": [ "events", ":event_id" ], "variable": [ { "key": "event_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-56b07c4e-2666-454d-b45d-a4c6aa49309d" }, { "id": "10c2d528-a592-4d08-a791-2544a0fbcb42", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events/:event_id", "host": [ "{{baseUrl}}" ], "path": [ "events", ":event_id" ], "variable": [ { "key": "event_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-10c2d528-a592-4d08-a791-2544a0fbcb42" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-46230538-5817-457f-ad56-041192566ff1" } ], "id": "95901649-7d34-402a-8764-15806ccca4d3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-95901649-7d34-402a-8764-15806ccca4d3" }, { "name": "list events", "id": "1ad4a966-50b8-41cb-96d7-8835e3e32730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/events?order=&since_token=&count=&event_type=", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The order of the returned list. Default is `desc`, which returns the newest records first. To list older records first, use `asc`.", "key": "order", "value": "" }, { "description": "The id of the item to start from (e.g., the last id received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Filter events by event type. If not specified, all event types are returned.", "key": "event_type", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all events in the authenticated environment." }, "response": [ { "id": "c45f1b4b-8844-4306-a5ce-755c86a2eada", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events?order=&since_token=&count=&event_type=", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The order of the returned list. Default is `desc`, which returns the newest records first. To list older records first, use `asc`.", "key": "order", "value": "" }, { "description": "The id of the item to start from (e.g., the last id received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Filter events by event type. If not specified, all event types are returned.", "key": "event_type", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"events\": [\n {\n \"event\": {\n \"id\": \"\",\n \"request_id\": \"\",\n \"event_type\": \"\",\n \"object_type\": \"\",\n \"object_key\": \"\",\n \"created_at\": \"\"\n }\n },\n {\n \"event\": {\n \"id\": \"\",\n \"request_id\": \"\",\n \"event_type\": \"\",\n \"object_type\": \"\",\n \"object_key\": \"\",\n \"created_at\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c45f1b4b-8844-4306-a5ce-755c86a2eada" }, { "id": "899523d7-3f86-4f3c-b084-2e21d89a24a8", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events?order=&since_token=&count=&event_type=", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The order of the returned list. Default is `desc`, which returns the newest records first. To list older records first, use `asc`.", "key": "order", "value": "" }, { "description": "The id of the item to start from (e.g., the last id received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Filter events by event type. If not specified, all event types are returned.", "key": "event_type", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-899523d7-3f86-4f3c-b084-2e21d89a24a8" }, { "id": "b2805455-ac1b-414e-a832-5a6a5bd4d712", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/events?order=&since_token=&count=&event_type=", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The order of the returned list. Default is `desc`, which returns the newest records first. To list older records first, use `asc`.", "key": "order", "value": "" }, { "description": "The id of the item to start from (e.g., the last id received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Filter events by event type. If not specified, all event types are returned.", "key": "event_type", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b2805455-ac1b-414e-a832-5a6a5bd4d712" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1ad4a966-50b8-41cb-96d7-8835e3e32730" } ], "id": "685632c5-38bb-4d7d-a4e8-e3f64f59d2c5", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-685632c5-38bb-4d7d-a4e8-e3f64f59d2c5" }, { "name": "gateways.{format}", "item": [ { "name": "Create a gateway", "id": "2c3eed47-05e6-4090-bc2f-165cfeac6f47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"sandbox\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ] }, "description": "Create (provision) a gateway to process card data in the authenticated environment. A test gateway is used to [test your integration](https://developer.spreedly.com/docs/testing/) to Spreedly and can only be used with [test payment methods](https://developer.spreedly.com/docs/test-data/). Production gateways process real card data and transactions. Production gateways are created using the credentials required for that gateway, meaning each call is slightly different depending on the gateway's API requirements." }, "response": [ { "id": "68a8d0de-57d4-4062-adb3-e950351a8991", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"sandbox\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateway\": {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-68a8d0de-57d4-4062-adb3-e950351a8991" }, { "id": "e33ed9ce-64d2-4c2b-a380-e35031fcf01f", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"sandbox\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e33ed9ce-64d2-4c2b-a380-e35031fcf01f" }, { "id": "f3312830-a676-4d09-9eb6-fa037e72ae61", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"gateway\": {\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"sandbox\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gateways.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f3312830-a676-4d09-9eb6-fa037e72ae61" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-2c3eed47-05e6-4090-bc2f-165cfeac6f47" }, { "name": "List created gateways", "id": "12a6e3c6-027d-4f2a-b24c-a1aa7eb94a60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways.{{format}}?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of gateways to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all gateways in the environment. This is different from the list of all supported gateways in that this will only return the gateway instances that have been provisioned in the authenticated environment." }, "response": [ { "id": "c7143dab-7123-4264-b840-927b27d06f99", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways.{{format}}?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of gateways to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateways\": [\n {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"token\": \"\",\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"description\": \"\",\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"state\": \"\",\n \"sandbox\": \"\",\n \"redacted\": \"\",\n \"credentials\": \"\",\n \"gateway_settings\": {},\n \"characteristics\": \"\",\n \"payment_methods\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c7143dab-7123-4264-b840-927b27d06f99" }, { "id": "57b0f55c-ff7d-4b13-bf00-4a75b1c72d27", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways.{{format}}?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of gateways to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-57b0f55c-ff7d-4b13-bf00-4a75b1c72d27" }, { "id": "379f58b7-d8f6-4b8e-9113-c7f92853c73b", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways.{{format}}?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of gateways to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-379f58b7-d8f6-4b8e-9113-c7f92853c73b" }, { "id": "fda09807-c0ff-4c70-8827-48ec3c2113e4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/gateways.{{format}}?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "gateways.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of gateways to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fda09807-c0ff-4c70-8827-48ec3c2113e4" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-12a6e3c6-027d-4f2a-b24c-a1aa7eb94a60" } ], "id": "27d49c4e-bac3-494c-87ba-a357b7517663", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-27d49c4e-bac3-494c-87ba-a357b7517663" }, { "name": "gateways_options.json", "item": [ { "name": "List supported gateways", "id": "dc0b8b89-1942-41d9-9143-68c51e6d23cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways_options.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways_options.json" ] }, "description": "Retrieve a list of all gateways, and their properties, supported by Spreedly. This call can be used to dynamically present a gateway credential form to users or to do any sort of dynamic rendering." }, "response": [ { "id": "b0ca0b08-6c05-4304-b8dd-bb72b431e3f4", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/gateways_options.json", "host": [ "{{baseUrl}}" ], "path": [ "gateways_options.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"gateways\": {\n \"name\": \"\",\n \"gateway_type\": \"\",\n \"characteristics\": [\n \"\",\n \"\"\n ],\n \"payment_methods\": [\n \"\",\n \"\"\n ],\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"supported_countries\": [\n \"\",\n \"\"\n ],\n \"supported_cardtypes\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n \"\",\n \"\"\n ],\n \"homepage\": \"\",\n \"display_api_url\": \"\",\n \"company_name\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b0ca0b08-6c05-4304-b8dd-bb72b431e3f4" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-dc0b8b89-1942-41d9-9143-68c51e6d23cc" } ], "id": "561dd0ab-fc8d-49f8-b551-b85109116998", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-561dd0ab-fc8d-49f8-b551-b85109116998" }, { "name": "merchant_profiles", "item": [ { "name": "{merchant_profile_token}", "item": [ { "name": "Show merchant profile", "id": "47a7cd89-278e-4c6f-814f-857840477f95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "id": "c877c5c1-29c3-4ba5-be8d-ba6f2cb03468", "key": "merchant_profile_token", "value": "", "description": "(Required) The token of the merchant profile" } ] }, "description": "Get a merchant profile with the given token." }, "response": [ { "id": "21346237-0b2c-436d-b28c-d93772d6bdc8", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant_profile\": {\n \"token\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sub_merchant_key\": \"\",\n \"card_networks\": {\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-21346237-0b2c-436d-b28c-d93772d6bdc8" }, { "id": "f272fb0d-042d-4ecd-bc13-c307584e2ca2", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f272fb0d-042d-4ecd-bc13-c307584e2ca2" }, { "id": "a1a36c4f-8af6-4259-9a07-80d9f693e51b", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a1a36c4f-8af6-4259-9a07-80d9f693e51b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-47a7cd89-278e-4c6f-814f-857840477f95" }, { "name": "Update merchant profile", "id": "0267aa40-2ab5-4f32-85e4-ca0768074c08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "id": "0f6d5839-c51c-445b-94e5-1e2421e4b3d1", "key": "merchant_profile_token", "value": "", "description": "(Required) The token of the merchant profile" } ] }, "description": "Update the `description` on the Merchant Profile. All other parameters of the Merchant Profile cannot be updated once created." }, "response": [ { "id": "e794a5a4-9ccb-4c23-8e89-1ff2ec9beb69", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant_profile\": {\n \"token\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sub_merchant_key\": \"\",\n \"card_networks\": {\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e794a5a4-9ccb-4c23-8e89-1ff2ec9beb69" }, { "id": "6209dd6c-d5cc-43d6-aa64-453add8c1d08", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6209dd6c-d5cc-43d6-aa64-453add8c1d08" }, { "id": "6087540c-e5d9-47e3-afa1-bbb416f05263", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6087540c-e5d9-47e3-afa1-bbb416f05263" }, { "id": "b6c5f845-d0e3-471d-8af2-df71ed3deeac", "name": "Unprocessable entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles/:merchant_profile_token", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles", ":merchant_profile_token" ], "variable": [ { "key": "merchant_profile_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b6c5f845-d0e3-471d-8af2-df71ed3deeac" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-0267aa40-2ab5-4f32-85e4-ca0768074c08" } ], "id": "eb666275-ae56-4238-a45b-c939e9908a3a", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-eb666275-ae56-4238-a45b-c939e9908a3a" }, { "name": "Create merchant profile", "id": "f52171fe-557f-478f-835c-2178f575cee6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\",\n \"sub_merchant_key\": \"\",\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ] }, "description": "Create a Merchant Profile that holds the SCA Provider. **At least one card type object must be included in the request.** The following card types are supported: Visa, Mastercard, American Express, Discover, Diners, JCB, Dankort, Union Pay, and Cartes Bancaires." }, "response": [ { "id": "65d357f6-70da-43a7-993d-b1b912a01363", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\",\n \"sub_merchant_key\": \"\",\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant_profile\": {\n \"token\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sub_merchant_key\": \"\",\n \"card_networks\": {\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-65d357f6-70da-43a7-993d-b1b912a01363" }, { "id": "2e1752d3-140c-485b-8fc5-f4428fcede1d", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\",\n \"sub_merchant_key\": \"\",\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2e1752d3-140c-485b-8fc5-f4428fcede1d" }, { "id": "47f76287-6f8e-4f33-948e-5580ffd99f6b", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile\": {\n \"description\": \"\",\n \"sub_merchant_key\": \"\",\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchant_profiles", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-47f76287-6f8e-4f33-948e-5580ffd99f6b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f52171fe-557f-478f-835c-2178f575cee6" }, { "name": "List merchant profiles", "id": "47fb2247-b2d6-4cbf-b4ab-63fe5f79c0e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchant_profiles?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of merchant profiles to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] }, "description": "Retrieve an [ordered and paginated](https://developer.spreedly.com/reference/order-and-pagination) list of all merchant profiles in the environment" }, "response": [ { "id": "a6c046f8-70a5-4b17-bebf-e42929af846d", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of merchant profiles to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant_profiles\": [\n {\n \"token\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sub_merchant_key\": \"\",\n \"card_networks\": {\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"sub_merchant_key\": \"\",\n \"card_networks\": {\n \"visa\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"mastercard\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"amex\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"discover\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"diners\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"jcb\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"dankort\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"union_pay\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"merchant_name\": \"\",\n \"country_code\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a6c046f8-70a5-4b17-bebf-e42929af846d" }, { "id": "46f61ce3-13a1-4cb6-824b-23924153b47a", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of merchant profiles to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-46f61ce3-13a1-4cb6-824b-23924153b47a" }, { "id": "2b54aaa9-d82e-4789-bdb8-7ff03323284c", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/merchant_profiles?order=&since_token=&count=", "host": [ "{{baseUrl}}" ], "path": [ "merchant_profiles" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of merchant profiles to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2b54aaa9-d82e-4789-bdb8-7ff03323284c" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-47fb2247-b2d6-4cbf-b4ab-63fe5f79c0e5" } ], "id": "d106a187-639e-47d1-bc35-12a005d7e9b3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d106a187-639e-47d1-bc35-12a005d7e9b3" }, { "name": "network_tokenization", "item": [ { "name": "card_metadata.{format}?payment_method_token={payment_method_token}", "item": [ { "name": "Show card metadata for a Network Token", "id": "acacd9f1-29eb-4f9b-bece-c4b68b66ed04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/network_tokenization/card_metadata.{{format}}?payment_method_token={{payment_method_token}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "card_metadata.{{format}}" ], "query": [ { "key": "payment_method_token", "value": "{{payment_method_token}}" } ] }, "description": "Retrieve metadata for a card that has been tokenized at a network.\n\nThe content of the `card_metadata` object is determined and can be changed by the card network at any time. Because of this, the keys in the response are potentially variable and should not be considered idempotent.\n" }, "response": [ { "id": "a85b10d0-8c7e-479d-9406-9930e890af83", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/card_metadata.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "card_metadata.{{format}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_metadata\": {\n \"backgroundColor\": \"\",\n \"foregroundColor\": \"\",\n \"labelColor\": \"\",\n \"contactEmail\": \"\",\n \"contactNumber\": \"\",\n \"contactName\": \"\",\n \"privacyPolicyURL\": \"\",\n \"termsAndConditionsURL\": \"\",\n \"termsAndConditionsID\": \"\",\n \"shortDescription\": \"\",\n \"longDescription\": \"\",\n \"cardData\": [\n {\n \"guid\": \"\",\n \"contentType\": \"\",\n \"content\": [\n {\n \"mimeType\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"mimeType\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ]\n },\n {\n \"guid\": \"\",\n \"contentType\": \"\",\n \"content\": [\n {\n \"mimeType\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"mimeType\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ]\n }\n ],\n \"unsupportedPresentationTypes\": [\n \"\",\n \"\"\n ],\n \"issuerFlags\": {\n \"deviceBinding\": \"\",\n \"cardholderVerification\": \"\",\n \"trustedBeneficiaryEnrollment\": \"\",\n \"delegatedAuthenticationSupported\": \"\",\n \"oboDeviceBinding\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a85b10d0-8c7e-479d-9406-9930e890af83" }, { "id": "ab2eaaf5-d08e-4d5f-bdab-40b6b50bc2cd", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/card_metadata.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "card_metadata.{{format}}" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ab2eaaf5-d08e-4d5f-bdab-40b6b50bc2cd" }, { "id": "44bfa376-630a-490e-ac79-a31e74fc17aa", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/card_metadata.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "card_metadata.{{format}}" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-44bfa376-630a-490e-ac79-a31e74fc17aa" }, { "id": "95a063c3-dc71-4fc6-936c-754cacac4453", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/card_metadata.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "card_metadata.{{format}}" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-95a063c3-dc71-4fc6-936c-754cacac4453" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-acacd9f1-29eb-4f9b-bece-c4b68b66ed04" } ], "id": "6c04293b-324d-4ea1-8fca-8156d57c6bd0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6c04293b-324d-4ea1-8fca-8156d57c6bd0" }, { "name": "token_status.{format}?payment_method_token={payment_method_token}", "item": [ { "name": "Show status for a Network Token", "id": "9ac49686-a290-422b-811e-494c880b9c77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/network_tokenization/token_status.{{format}}?payment_method_token={{payment_method_token}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "token_status.{{format}}" ], "query": [ { "key": "payment_method_token", "value": "{{payment_method_token}}" } ] }, "description": "Retrieve the status of a card that has been tokenized at a network.\n\nThis endpoint provides the current status of a network token, either active or inactive.\n" }, "response": [ { "id": "c896096b-ffdf-40e4-8a8c-4626fa36be06", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/token_status.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "token_status.{{format}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"token_status\": \"\"\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c896096b-ffdf-40e4-8a8c-4626fa36be06" }, { "id": "761c8d4a-c3a7-4543-a19c-4b9de853ecdd", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/token_status.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "token_status.{{format}}" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-761c8d4a-c3a7-4543-a19c-4b9de853ecdd" }, { "id": "3a71c864-aa04-4a88-875f-3e2a298e1925", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/token_status.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "token_status.{{format}}" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3a71c864-aa04-4a88-875f-3e2a298e1925" }, { "id": "3cb4cff0-2e4b-4db0-8d91-29fa9d4cf338", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/network_tokenization/token_status.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "network_tokenization", "token_status.{{format}}" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3cb4cff0-2e4b-4db0-8d91-29fa9d4cf338" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-9ac49686-a290-422b-811e-494c880b9c77" } ], "id": "19ee8b68-8607-4144-a6e1-92fcacca7a0d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-19ee8b68-8607-4144-a6e1-92fcacca7a0d" } ], "id": "8c6ce24b-32de-4c39-9b87-ddbe4dda553c", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8c6ce24b-32de-4c39-9b87-ddbe4dda553c" }, { "name": "payment_methods", "item": [ { "name": "events", "item": [ { "name": "{event_token}", "item": [ { "name": "Show payment method event", "id": "ec3babbe-55e3-4b2a-b162-69a2dcb9f874", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "Payment Method Event" } ], "url": { "raw": "{{baseUrl}}/payment_methods/events/:event_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events", ":event_token" ], "variable": [ { "id": "7e30e416-33b3-465c-9184-649c7c69a4c3", "key": "event_token", "value": "", "description": "(Required) The token of the payment method event" } ] }, "description": "Get a specific payment method event by its token.\n\nPayment method events contain detailed information about changes to payment methods, including the event type, associated payment method, event data, and timing information.\n\n*Response Format*\n\nThe response format varies by event type:\n- `AddPaymentMethod` events are returned as `transaction` objects with embedded payment method data\n- All other events are returned as `payment_method_event` objects\n" }, "response": [ { "id": "54cbe6ae-e3b7-4d34-992b-4da08bcb8a1c", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "Payment Method Event" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/events/:event_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events", ":event_token" ], "variable": [ { "key": "event_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method_event\": {\n \"token\": \"\",\n \"request_id\": \"\",\n \"created_at\": \"\",\n \"payment_method_key\": \"\",\n \"event_type\": \"\",\n \"event_data\": {},\n \"state\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-54cbe6ae-e3b7-4d34-992b-4da08bcb8a1c" }, { "id": "6d46589a-6eca-4247-9701-ff117710619b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/events/:event_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events", ":event_token" ], "variable": [ { "key": "event_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-6d46589a-6eca-4247-9701-ff117710619b" }, { "id": "c8c66caa-191f-41d4-aaed-dffa714d66e3", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/events/:event_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events", ":event_token" ], "variable": [ { "key": "event_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c8c66caa-191f-41d4-aaed-dffa714d66e3" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-ec3babbe-55e3-4b2a-b162-69a2dcb9f874" } ], "id": "829e1733-6601-4ecc-847e-d2bd9d57e0c0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-829e1733-6601-4ecc-847e-d2bd9d57e0c0" }, { "name": "List all payment method events", "id": "0fb1a547-53fb-4a97-8e52-65d2e1c85d36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "List events" } ], "url": { "raw": "{{baseUrl}}/payment_methods/events?order=&since_token=&event_type=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "Filter events by event type (e.g., AddPaymentMethod, RetainPaymentMethod, RedactPaymentMethod, ReplacePaymentMethod, UpdatePaymentMethod)", "key": "event_type", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all payment method events in the authenticated environment.\n\nPayment method events track important changes to payment methods such as creation, retention, redaction, and other lifecycle events. This endpoint allows you to retrieve these events with optional filtering and pagination.\n\n*Response Format*\n\nThe response format varies by event type:\n- `AddPaymentMethod` events are returned as `transaction` objects with embedded payment method data\n- All other events are returned as `payment_method_event` objects\n" }, "response": [ { "id": "e64af75b-23d7-4595-8d27-32b5dad8a039", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "List events" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/events?order=&since_token=&event_type=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "Filter events by event type (e.g., AddPaymentMethod, RetainPaymentMethod, RedactPaymentMethod, ReplacePaymentMethod, UpdatePaymentMethod)", "key": "event_type", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method_events\": [\n {\n \"token\": \"\",\n \"request_id\": \"\",\n \"created_at\": \"\",\n \"payment_method_key\": \"\",\n \"event_type\": \"\",\n \"event_data\": {},\n \"state\": \"\",\n \"message\": \"\"\n },\n {\n \"token\": \"\",\n \"request_id\": \"\",\n \"created_at\": \"\",\n \"payment_method_key\": \"\",\n \"event_type\": \"\",\n \"event_data\": {},\n \"state\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e64af75b-23d7-4595-8d27-32b5dad8a039" }, { "id": "e5afa1f1-20a8-40c8-980f-f713aaac7cc1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/events?order=&since_token=&event_type=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "Filter events by event type (e.g., AddPaymentMethod, RetainPaymentMethod, RedactPaymentMethod, ReplacePaymentMethod, UpdatePaymentMethod)", "key": "event_type", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e5afa1f1-20a8-40c8-980f-f713aaac7cc1" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-0fb1a547-53fb-4a97-8e52-65d2e1c85d36" } ], "id": "b0ad6d6b-9f58-4bb3-81ef-cf81f1ce858e", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b0ad6d6b-9f58-4bb3-81ef-cf81f1ce858e" }, { "name": "{payment_method_token}", "item": [ { "name": "retain", "item": [ { "name": "Retain payment method", "id": "e2ca4bda-40cc-46ea-a147-0e5c96b4a460", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/retain", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "retain" ], "variable": [ { "id": "0101c1a5-fd7b-4ce0-8433-269528ba0634", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Retain (keep in the Spreedly vault for future use) a payment method." }, "response": [ { "id": "2b4ca37c-9cf2-4b75-806e-2de37e6512e5", "name": "successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/retain", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "retain" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"transaction_type\": \"\",\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2b4ca37c-9cf2-4b75-806e-2de37e6512e5" }, { "id": "5d438eb9-d1ae-4267-aebc-e5b944197d33", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/retain", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "retain" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5d438eb9-d1ae-4267-aebc-e5b944197d33" }, { "id": "76a0c917-b896-46c6-a07e-41401fe55d72", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/retain", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "retain" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-76a0c917-b896-46c6-a07e-41401fe55d72" }, { "id": "f32d58f7-b3dc-4183-9e85-39ab21ae1269", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/retain", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "retain" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f32d58f7-b3dc-4183-9e85-39ab21ae1269" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-e2ca4bda-40cc-46ea-a147-0e5c96b4a460" } ], "id": "7b77431a-ceff-4d20-9a22-c206b543dd75", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7b77431a-ceff-4d20-9a22-c206b543dd75" }, { "name": "redact", "item": [ { "name": "Redact payment method", "id": "c6557079-8354-496b-98a4-c4f5fcd8add9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"remove_from_gateway\": \"\",\n \"remove_personal_data\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "redact" ], "variable": [ { "id": "bfd8878a-b4c5-429f-96e1-e26ba77d51fa", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Redact (strip of any sensitive credentials and make inactive) a payment method." }, "response": [ { "id": "02765020-be5c-4e18-a77d-9000e3125d13", "name": "successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"remove_from_gateway\": \"\",\n \"remove_personal_data\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "redact" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"transaction_type\": \"\",\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-02765020-be5c-4e18-a77d-9000e3125d13" }, { "id": "cb51991b-5269-4b5f-af38-20151f419bd5", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"remove_from_gateway\": \"\",\n \"remove_personal_data\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "redact" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cb51991b-5269-4b5f-af38-20151f419bd5" }, { "id": "ae18432b-8ae2-48c2-a9a7-4807e20de1df", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"remove_from_gateway\": \"\",\n \"remove_personal_data\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "redact" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ae18432b-8ae2-48c2-a9a7-4807e20de1df" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-c6557079-8354-496b-98a4-c4f5fcd8add9" } ], "id": "96f18a62-366c-4dfd-b520-f770097d7044", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-96f18a62-366c-4dfd-b520-f770097d7044" }, { "name": "update_gratis", "item": [ { "name": "Update gratis payment method", "id": "6e1cd128-e4c4-4aba-b157-54fe51e311f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"managed\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"callback_url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/update_gratis", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "update_gratis" ], "variable": [ { "id": "a53d9688-33c4-487c-92e8-c75dccc69eac", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Update a payment method's management state and some specific payment method parameters associated with Advanced Vault.\nFor further details, see [Advanced Vault](https://developer.spreedly.com/docs/advanced-vault).\n\nPlease note, that this API call is only available to merchants who are currently enrolled in Advanced Vault.\n" }, "response": [ { "id": "c71463fb-641c-4894-a23f-63ecdf70164e", "name": "successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"managed\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"callback_url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/update_gratis", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "update_gratis" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c71463fb-641c-4894-a23f-63ecdf70164e" }, { "id": "61ba6785-4503-4e7f-921f-4763bc81ca39", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"managed\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"callback_url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/update_gratis", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "update_gratis" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-61ba6785-4503-4e7f-921f-4763bc81ca39" }, { "id": "1e08c49b-2c66-4524-8275-96ccf54ddb4c", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"managed\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"callback_url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/update_gratis", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "update_gratis" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1e08c49b-2c66-4524-8275-96ccf54ddb4c" }, { "id": "793647c5-8a8d-4f86-90de-2d3e9d58137b", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"managed\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"callback_url\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/update_gratis", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "update_gratis" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-793647c5-8a8d-4f86-90de-2d3e9d58137b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6e1cd128-e4c4-4aba-b157-54fe51e311f2" } ], "id": "1a3044a7-1c4d-4210-8a14-c12818c163e3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1a3044a7-1c4d-4210-8a14-c12818c163e3" }, { "name": "transactions", "item": [ { "name": "List transactions payment method", "id": "367fcc82-afa1-4567-ab73-e52285efb1bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/transactions?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "transactions" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ], "variable": [ { "id": "bb553ccb-ad27-45ed-a248-8b55edcab9b2", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Get an ordered and paginated list of transactions executed against a specific payment method." }, "response": [ { "id": "58073a38-94f8-4ca2-bb47-f0a48e9eb5e0", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/transactions?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "transactions" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-58073a38-94f8-4ca2-bb47-f0a48e9eb5e0" }, { "id": "0388be05-8730-4994-86da-6cbbf46482a1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/transactions?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "transactions" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0388be05-8730-4994-86da-6cbbf46482a1" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-367fcc82-afa1-4567-ab73-e52285efb1bd" } ], "id": "06ee588a-49be-49e0-9545-9e19e1d453df", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-06ee588a-49be-49e0-9545-9e19e1d453df" }, { "name": "metadata", "item": [ { "name": "Delete metadata payment method", "id": "205bb2b6-952f-4337-b34d-533da1ce6f07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keys\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/metadata", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "metadata" ], "variable": [ { "id": "f4419e63-2e21-453e-be9e-ae1308833ce5", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Remove key value pairs from a payment method's metadata." }, "response": [ { "id": "cd391f65-ee95-4199-8776-60fa0fd52033", "name": "successful", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"keys\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/metadata", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "metadata" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cd391f65-ee95-4199-8776-60fa0fd52033" }, { "id": "a296afff-e4cb-4dc9-8dd4-b44509196d5b", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"keys\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/metadata", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "metadata" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a296afff-e4cb-4dc9-8dd4-b44509196d5b" }, { "id": "3611c0c8-ecc8-4b5d-a2d3-0fdc328e50d7", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"keys\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/metadata", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "metadata" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3611c0c8-ecc8-4b5d-a2d3-0fdc328e50d7" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-205bb2b6-952f-4337-b34d-533da1ce6f07" } ], "id": "b85ba23c-af01-432c-8bb8-838e29a7b2b0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b85ba23c-af01-432c-8bb8-838e29a7b2b0" }, { "name": "recache", "item": [ { "name": "Recache payment method", "id": "5ae5d243-4bb0-4a80-927a-28c110fe7af9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"verification_value\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/recache", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "recache" ], "variable": [ { "id": "7551e736-6136-4710-b08e-ecb0b025c1b0", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Update a credit card's verification value (CVV) so the card can be transacted against.\n\nNote: A credit card must be retained in your environment in order to re-cache its CVV.\n" }, "response": [ { "id": "1f7da19f-dfb0-4d5a-a9c2-c283db2899f5", "name": "successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"verification_value\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/recache", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "recache" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1f7da19f-dfb0-4d5a-a9c2-c283db2899f5" }, { "id": "bd2e4ec1-280a-444b-bf03-024295625ed3", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"verification_value\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/recache", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "recache" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-bd2e4ec1-280a-444b-bf03-024295625ed3" }, { "id": "76bba9ad-2125-45f6-b6a6-86895b627df5", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"verification_value\": \"\"\n },\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/recache", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "recache" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-76bba9ad-2125-45f6-b6a6-86895b627df5" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-5ae5d243-4bb0-4a80-927a-28c110fe7af9" } ], "id": "f3a460ef-5568-4511-ab5b-de8e7f8f2352", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f3a460ef-5568-4511-ab5b-de8e7f8f2352" }, { "name": "events", "item": [ { "name": "List events for a payment method", "id": "cd142c36-6bc2-4d1b-b461-5c65254f22f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "List events" } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/events?order=&since_token=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ], "variable": [ { "id": "94244689-2974-4871-a3aa-17e71807225d", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Get a list of events for a specific payment method.\n\n*Response Format*\n\nThe response format varies by event type:\n- `AddPaymentMethod` events are returned as `transaction` objects with embedded payment method data\n- All other events are returned as `payment_method_event` objects\n" }, "response": [ { "id": "fa66dbed-7b17-42dd-93aa-b10d04f8a6e8", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "List events" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/events?order=&since_token=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method_events\": [\n {\n \"token\": \"\",\n \"request_id\": \"\",\n \"created_at\": \"\",\n \"payment_method_key\": \"\",\n \"event_type\": \"\",\n \"event_data\": {},\n \"state\": \"\",\n \"message\": \"\"\n },\n {\n \"token\": \"\",\n \"request_id\": \"\",\n \"created_at\": \"\",\n \"payment_method_key\": \"\",\n \"event_type\": \"\",\n \"event_data\": {},\n \"state\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fa66dbed-7b17-42dd-93aa-b10d04f8a6e8" }, { "id": "62b6581a-51a1-418f-9c70-f107735e61c9", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/events?order=&since_token=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-62b6581a-51a1-418f-9c70-f107735e61c9" }, { "id": "4668f8fb-7be0-423b-9051-549178f0d4f9", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token/events?order=&since_token=&count=&include_transactions=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token", "events" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "Whether to include gateway transactions alongside events. Default is `false`. When `true`, returns a unified timeline of events and transactions sorted by creation time.", "key": "include_transactions", "value": "" } ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-4668f8fb-7be0-423b-9051-549178f0d4f9" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-cd142c36-6bc2-4d1b-b461-5c65254f22f4" } ], "id": "001a960d-c8f2-4cb8-8edd-c4adc0ed83e1", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-001a960d-c8f2-4cb8-8edd-c4adc0ed83e1" }, { "name": "Show payment method", "id": "790f19fb-2d94-471e-94b5-5f951fff10ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "id": "988547f3-d20e-4187-833f-58425d8812c8", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Get a payment method with the given token." }, "response": [ { "id": "929d3f86-5e3b-4050-ab6b-d88faa9d9b10", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\",\n \"network_token\": {\n \"status\": \"\",\n \"v_provisioned_token_id\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-929d3f86-5e3b-4050-ab6b-d88faa9d9b10" }, { "id": "d1303f18-ec5b-46d8-b625-74ec08c0dc52", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-d1303f18-ec5b-46d8-b625-74ec08c0dc52" }, { "id": "c2dda605-138e-4dcc-b54d-7ffb77a051b1", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c2dda605-138e-4dcc-b54d-7ffb77a051b1" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-790f19fb-2d94-471e-94b5-5f951fff10ec" }, { "name": "Update payment method", "id": "433ce444-48b1-4c22-b65f-1e834ea5fe68", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"attribute\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "id": "6979fb6b-1506-4479-b029-db502c8d4f8c", "key": "payment_method_token", "value": "", "description": "(Required) The token of the payment method" } ] }, "description": "Update a payment method's non-sensitive attributes." }, "response": [ { "id": "04c905c3-b971-455c-bc79-89caccab5b5f", "name": "successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"attribute\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-04c905c3-b971-455c-bc79-89caccab5b5f" }, { "id": "50d84128-0c9c-4782-ab38-0a235cc5eacb", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"attribute\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-50d84128-0c9c-4782-ab38-0a235cc5eacb" }, { "id": "61e452a6-0884-45b0-a308-228e1773c1bd", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"attribute\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-61e452a6-0884-45b0-a308-228e1773c1bd" }, { "id": "cc05031a-cb53-47df-be44-32ed013cbb35", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"attribute\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:payment_method_token", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":payment_method_token" ], "variable": [ { "key": "payment_method_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cc05031a-cb53-47df-be44-32ed013cbb35" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-433ce444-48b1-4c22-b65f-1e834ea5fe68" } ], "id": "f0e201a0-f396-46cb-bb86-ced08c05bc6b", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f0e201a0-f396-46cb-bb86-ced08c05bc6b" }, { "name": "Create payment method", "id": "d84a4c7b-181d-4195-ace5-fa0ccaa32a3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"payment_method_type\": \"\",\n \"reference\": \"\",\n \"gateway_type\": \"\",\n \"email\": \"\",\n \"retained\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {},\n \"provision_network_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] }, "description": "Add a payment method (credit card, bank account/ACH, Apple Pay, Google Pay, or third party token) to the authenticated environment's vault.\n\nTo create a test payment method, use one of the [test card numbers](https://developer.spreedly.com/docs/test-data). For more information see the [Spreedly testing guide](https://developer.spreedly.com/docs/testing).\n\nThird party tokens are payment methods stored in the Spreedly vault, that are a reference to another payment method stored at the gateway's vault. For more information see the [third party token guide](https://developer.spreedly.com/docs/third-party-vaulting).\n" }, "response": [ { "id": "39e75042-c569-477d-827a-d6bc3fe1b484", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Network Token Provisioned" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"payment_method_type\": \"\",\n \"reference\": \"\",\n \"gateway_type\": \"\",\n \"email\": \"\",\n \"retained\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {},\n \"provision_network_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"retained\": \"\",\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"network_tokenization\": {\n \"provisioned\": false,\n \"token_status\": \"\",\n \"token_reference\": \"\",\n \"token_first_six_digits\": \"\",\n \"token_last_four_digits\": \"\",\n \"token_created_at\": \"\",\n \"token_updated_at\": \"\",\n \"attempted\": false,\n \"errors\": [\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"action\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-39e75042-c569-477d-827a-d6bc3fe1b484" }, { "id": "06de83e3-687e-46ac-96ec-6c1f6c50ad59", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"payment_method\": {\n \"credit_card\": {\n \"number\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"verification_value\": \"\",\n \"company\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"bank_account\": {\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"bank_account_type\": \"checking\",\n \"bank_account_holder_type\": \"business\",\n \"full_name\": \"\"\n },\n \"apple_pay\": {\n \"payment_data\": {\n \"version\": {},\n \"data\": {},\n \"signature\": {},\n \"header\": {\n \"ephemeralPublicKey\": {},\n \"transactionId\": {},\n \"publicKeyHash\": {}\n }\n },\n \"test_card_number\": {\n \"description\": \"Apple Pay does not provide a way to create a test payment token. To mark this as a test Apple Pay payment method, specify a [test card number](https://developer.spreedly.com/docs/test-data#credit-cards) in this field. Doing so will prevent this payment method from being used against a production gateway, while still verifying the submitted Apple Pay payment data.\"\n }\n },\n \"google_pay\": {\n \"payment_data\": {\n \"signature\": \"\",\n \"protocolVersion\": \"\",\n \"signedMessage\": \"\"\n },\n \"test_card_number\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"payment_method_type\": \"\",\n \"reference\": \"\",\n \"gateway_type\": \"\",\n \"email\": \"\",\n \"retained\": \"\",\n \"allow_blank_name\": \"\",\n \"allow_expired_date\": \"\",\n \"allow_blank_date\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"metadata\": {},\n \"provision_network_token\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-06de83e3-687e-46ac-96ec-6c1f6c50ad59" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d84a4c7b-181d-4195-ace5-fa0ccaa32a3e" }, { "name": "List payment methods", "id": "56a45410-441d-4156-b9cd-50e4f0c5d478", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_methods?order=&since_token=&metadata=&state=&count=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "A metadata key/value pair represented as a hash (e.g. metadata[key]=value).", "key": "metadata", "value": "" }, { "description": "The list of storage_states to return. By default returns retained, acceptable values are retained, redacted, cached, used", "key": "state", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all retained payment methods in the authenticated environment.\n\n*States*\nPayment methods can exist in several states in the Spreedly vault - retained, redacted, cached, or used. Retained payment methods are stored in Spreedly's vault until redacted. Redacted payment methods are payment methods that were either not retained or have been manually redacted. Cached payment methods are payment methods that have not been retained but have not yet been automatically redacted yet. Cached payment methods can still be retained. For more information, please see our guide on [retaining payment methods](https://developer.spreedly.com/docs/create-transactions#retain).\n\nIf no state parameter or an invalid state parameter is passed, list will only return retained payment methods. If the state parameter is passed, list will return those parameters: retained, redacted, cached, used.\n\nExample: `https://core.spreedly.com/v1/payment_methods.json?state=retained,redacted,cached,used`\n\nIf the state parameter is combined with other existing parameters such as metadata, both will be considered.\n\nExample: `https://core.spreedly.com/v1/payment_methods.json?metadata[customer_id]=123abc&state=redacted,retained`\n" }, "response": [ { "id": "2ce4afa8-c1dc-4a46-ae55-767aa54c4f20", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods?order=&since_token=&metadata=&state=&count=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "A metadata key/value pair represented as a hash (e.g. metadata[key]=value).", "key": "metadata", "value": "" }, { "description": "The list of storage_states to return. By default returns retained, acceptable values are retained, redacted, cached, used", "key": "state", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_methods\": [\n {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2ce4afa8-c1dc-4a46-ae55-767aa54c4f20" }, { "id": "8b703902-e4c8-4eda-9259-1bc66853405b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payment_methods?order=&since_token=&metadata=&state=&count=", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "A metadata key/value pair represented as a hash (e.g. metadata[key]=value).", "key": "metadata", "value": "" }, { "description": "The list of storage_states to return. By default returns retained, acceptable values are retained, redacted, cached, used", "key": "state", "value": "" }, { "description": "The number of payment methods to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-8b703902-e4c8-4eda-9259-1bc66853405b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-56a45410-441d-4156-b9cd-50e4f0c5d478" } ], "id": "56dbdfe5-2063-4ee2-a3d3-9c115bae23f0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-56dbdfe5-2063-4ee2-a3d3-9c115bae23f0" }, { "name": "payments", "item": [ { "name": "{payment_token}", "item": [ { "name": "Show payment", "id": "b02566bd-3796-41cb-b03b-098111d5410d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_token", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_token" ], "variable": [ { "id": "ce110ab0-0e99-4887-91de-6c52bf9cfd78", "key": "payment_token", "value": "", "description": "(Required) The token of the payment" } ] }, "description": "Retrieve a payment object by its token. A payment represents a collection of transaction attempts\nmade against one or more gateways when performing a [Recover transaction](https://developer.spreedly.com/docs/recover).\n" }, "response": [ { "id": "c6eb6c9b-72d3-4daa-8be2-894079eda5e5", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payments/:payment_token", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_token" ], "variable": [ { "key": "payment_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"token\": \"\",\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"stats\": {\n \"pan_retry_attempts\": \"\",\n \"recover_attempts\": \"\",\n \"total_attempts\": \"\"\n },\n \"transactions\": [\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n },\n {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"gateway_transaction_id\": \"\",\n \"retain_on_success\": \"\",\n \"payment_method_added\": \"\",\n \"response\": {},\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n },\n \"merchant_profile_key\": \"\",\n \"sub_merchant_key\": \"\",\n \"gateway_specific_response_fields\": {},\n \"transaction_metadata\": {},\n \"sca_authentication\": \"\",\n \"payment_snapshot\": {\n \"gateway_tokens\": [\n \"\",\n \"\"\n ],\n \"attempts\": \"\",\n \"messages\": {},\n \"mode\": \"\",\n \"custom_error_used\": \"\",\n \"override_default_error_codes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_token\": \"\",\n \"previous_transaction_tokens\": [\n \"\",\n \"\"\n ]\n },\n \"protection_provider_key\": \"\",\n \"protection_parameters\": {\n \"delivery_method\": \"\",\n \"delivery_type\": \"PHYSICAL\",\n \"cart_items\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"type\": \"TANGIBLE\",\n \"price\": \"\"\n }\n ],\n \"test_scenario\": {\n \"scenario\": \"protect_approved\"\n },\n \"fraud_token\": \"\",\n \"forter_mobile_uid\": \"\",\n \"user_agent\": \"\",\n \"customer_account_id\": \"\",\n \"customer_account_type\": \"BUSINESS\",\n \"customer_account_creation_date\": \"\",\n \"billing_name\": \"\",\n \"billing_first_name\": \"\",\n \"billing_last_name\": \"\",\n \"email\": \"\",\n \"billing_country\": \"\",\n \"billing_address1\": \"\",\n \"billing_address2\": \"\",\n \"billing_city\": \"\",\n \"billing_zip\": \"\",\n \"billing_state\": \"\",\n \"billing_phone_number\": \"\",\n \"shipping_name\": \"\",\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_email\": \"\",\n \"shipping_country\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_state\": \"\",\n \"shipping_phone_number\": \"\"\n },\n \"order_id\": \"\",\n \"ip\": \"\",\n \"description\": \"\",\n \"email\": \"\",\n \"merchant_name_descriptor\": \"\",\n \"merchant_location_descriptor\": \"\",\n \"gateway_specific_fields\": [\n \"\",\n \"\"\n ],\n \"gateway_latency_ms\": \"\",\n \"warning\": \"\",\n \"application_id\": \"\",\n \"amount\": \"\",\n \"local_amount\": \"\",\n \"currency_code\": \"\",\n \"stored_credential_initiator\": \"\",\n \"stored_credential_reason_type\": \"\",\n \"shipping_address\": {},\n \"api_urls\": \"\",\n \"attempt_3dsecure\": \"\",\n \"workflow_key\": \"\",\n \"order_data\": {},\n \"customer_data\": {},\n \"risk_data\": {},\n \"merchant_metadata\": {},\n \"gateway_response\": {},\n \"pan_retry\": \"\",\n \"protect_fraud_check\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"protection_provider_key\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"message\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n }\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c6eb6c9b-72d3-4daa-8be2-894079eda5e5" }, { "id": "5a2ac083-0d59-4eb8-b476-3acc31513399", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payments/:payment_token", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_token" ], "variable": [ { "key": "payment_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5a2ac083-0d59-4eb8-b476-3acc31513399" }, { "id": "3a061e77-4ce4-46da-957d-a200b64030ee", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/payments/:payment_token", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_token" ], "variable": [ { "key": "payment_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3a061e77-4ce4-46da-957d-a200b64030ee" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b02566bd-3796-41cb-b03b-098111d5410d" } ], "id": "eaa9433b-06b3-4964-97de-fce452bece70", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-eaa9433b-06b3-4964-97de-fce452bece70" } ], "id": "d05eacdc-c893-4433-9973-30c6434344e6", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d05eacdc-c893-4433-9973-30c6434344e6" }, { "name": "protection", "item": [ { "name": "{transaction_token}", "item": [ { "name": "claims", "item": [ { "name": "Forward a claim to the protection provider", "id": "8dd479f5-71f7-4cf0-b581-01513b594cda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"case_id\": \"\",\n \"charge_id\": \"\",\n \"currency\": \"\",\n \"due_date\": \"\",\n \"issue_date\": \"\",\n \"order_id\": \"\",\n \"processor_name\": \"\",\n \"reason_code\": \"\",\n \"reason_description\": \"\",\n \"reason_type\": \"FRAUD\",\n \"status\": \"OPEN\",\n \"additional_amount\": \"\",\n \"comments\": \"\",\n \"source_type\": \"PROCESSOR_CB\",\n \"type\": \"CHARGEBACK\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/:transaction_token/claims", "host": [ "{{baseUrl}}" ], "path": [ "protection", ":transaction_token", "claims" ], "variable": [ { "id": "3430533c-b4a1-41aa-ad5d-0e1adf2bc409", "key": "transaction_token", "value": "", "description": "(Required) The token of the disputed transaction" } ] }, "description": "Forward a claim to the protection provider" }, "response": [ { "id": "aa5a5082-b8ea-4d8d-9997-3670020b3aa9", "name": "Forwarded", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"case_id\": \"\",\n \"charge_id\": \"\",\n \"currency\": \"\",\n \"due_date\": \"\",\n \"issue_date\": \"\",\n \"order_id\": \"\",\n \"processor_name\": \"\",\n \"reason_code\": \"\",\n \"reason_description\": \"\",\n \"reason_type\": \"FRAUD\",\n \"status\": \"OPEN\",\n \"additional_amount\": \"\",\n \"comments\": \"\",\n \"source_type\": \"PROCESSOR_CB\",\n \"type\": \"CHARGEBACK\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/:transaction_token/claims", "host": [ "{{baseUrl}}" ], "path": [ "protection", ":transaction_token", "claims" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"claim\": {\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-aa5a5082-b8ea-4d8d-9997-3670020b3aa9" }, { "id": "0999e91e-8669-4043-bd08-526f7bed2fce", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"case_id\": \"\",\n \"charge_id\": \"\",\n \"currency\": \"\",\n \"due_date\": \"\",\n \"issue_date\": \"\",\n \"order_id\": \"\",\n \"processor_name\": \"\",\n \"reason_code\": \"\",\n \"reason_description\": \"\",\n \"reason_type\": \"FRAUD\",\n \"status\": \"OPEN\",\n \"additional_amount\": \"\",\n \"comments\": \"\",\n \"source_type\": \"PROCESSOR_CB\",\n \"type\": \"CHARGEBACK\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/:transaction_token/claims", "host": [ "{{baseUrl}}" ], "path": [ "protection", ":transaction_token", "claims" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0999e91e-8669-4043-bd08-526f7bed2fce" }, { "id": "9f87b71e-ffc1-46fe-bc68-1857205daa29", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"case_id\": \"\",\n \"charge_id\": \"\",\n \"currency\": \"\",\n \"due_date\": \"\",\n \"issue_date\": \"\",\n \"order_id\": \"\",\n \"processor_name\": \"\",\n \"reason_code\": \"\",\n \"reason_description\": \"\",\n \"reason_type\": \"FRAUD\",\n \"status\": \"OPEN\",\n \"additional_amount\": \"\",\n \"comments\": \"\",\n \"source_type\": \"PROCESSOR_CB\",\n \"type\": \"CHARGEBACK\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/:transaction_token/claims", "host": [ "{{baseUrl}}" ], "path": [ "protection", ":transaction_token", "claims" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-9f87b71e-ffc1-46fe-bc68-1857205daa29" }, { "id": "f6764688-6b7c-493c-8ed3-4758d8075223", "name": "Unprocessable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"case_id\": \"\",\n \"charge_id\": \"\",\n \"currency\": \"\",\n \"due_date\": \"\",\n \"issue_date\": \"\",\n \"order_id\": \"\",\n \"processor_name\": \"\",\n \"reason_code\": \"\",\n \"reason_description\": \"\",\n \"reason_type\": \"FRAUD\",\n \"status\": \"OPEN\",\n \"additional_amount\": \"\",\n \"comments\": \"\",\n \"source_type\": \"PROCESSOR_CB\",\n \"type\": \"CHARGEBACK\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/:transaction_token/claims", "host": [ "{{baseUrl}}" ], "path": [ "protection", ":transaction_token", "claims" ], "variable": [ { "key": "transaction_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f6764688-6b7c-493c-8ed3-4758d8075223" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8dd479f5-71f7-4cf0-b581-01513b594cda" } ], "id": "28ba4a5c-ea0c-4081-ac44-394d8f83e958", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-28ba4a5c-ea0c-4081-ac44-394d8f83e958" } ], "id": "259f9096-7623-458d-a58c-8d6e7bc79cd3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-259f9096-7623-458d-a58c-8d6e7bc79cd3" }, { "name": "events.{format}", "item": [ { "name": "List protection events", "id": "01496c60-0847-4fee-86cf-0a3a30746ee6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/protection/events.{{format}}?order=&since_token=&count=&state=", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The state of the protection check. Possible values are `pending`, `succeeded`, and `failed`.", "key": "state", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all protection events in the environment." }, "response": [ { "id": "9ee5c3e9-2173-4ae6-8d24-79157c50deba", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events.{{format}}?order=&since_token=&count=&state=", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The state of the protection check. Possible values are `pending`, `succeeded`, and `failed`.", "key": "state", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"events\": [\n {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"fraud_control_vendor_key\": \"\",\n \"vendor_transaction_id\": \"\",\n \"order_id\": \"\",\n \"protection_provider_key\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n },\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"sca_provider_key\": \"\",\n \"acs_transaction_id\": \"\",\n \"three_ds_server_trans_id\": \"\",\n \"directory_server_transaction_id\": \"\",\n \"xid\": \"\",\n \"three_ds_version\": \"\",\n \"flow_performed\": \"\",\n \"ecommerce_indicator\": \"\",\n \"directory_response_status\": \"\",\n \"authentication_response_status\": \"\",\n \"authentication_value\": \"\",\n \"trans_status_reason\": \"\",\n \"daf\": \"\",\n \"payment_method_key\": \"\"\n },\n {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"fraud_control_vendor_key\": \"\",\n \"vendor_transaction_id\": \"\",\n \"order_id\": \"\",\n \"protection_provider_key\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n },\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"sca_provider_key\": \"\",\n \"acs_transaction_id\": \"\",\n \"three_ds_server_trans_id\": \"\",\n \"directory_server_transaction_id\": \"\",\n \"xid\": \"\",\n \"three_ds_version\": \"\",\n \"flow_performed\": \"\",\n \"ecommerce_indicator\": \"\",\n \"directory_response_status\": \"\",\n \"authentication_response_status\": \"\",\n \"authentication_value\": \"\",\n \"trans_status_reason\": \"\",\n \"daf\": \"\",\n \"payment_method_key\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-9ee5c3e9-2173-4ae6-8d24-79157c50deba" }, { "id": "344a4c57-ebbb-401f-a0e6-fd0d97441b71", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events.{{format}}?order=&since_token=&count=&state=", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The state of the protection check. Possible values are `pending`, `succeeded`, and `failed`.", "key": "state", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-344a4c57-ebbb-401f-a0e6-fd0d97441b71" }, { "id": "bd1b77f3-57ce-40b3-a45e-599e8dddf5ef", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events.{{format}}?order=&since_token=&count=&state=", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The state of the protection check. Possible values are `pending`, `succeeded`, and `failed`.", "key": "state", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-bd1b77f3-57ce-40b3-a45e-599e8dddf5ef" }, { "id": "e5ba4f77-bf55-461d-80ae-6bf954de7e5a", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events.{{format}}?order=&since_token=&count=&state=", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events.{{format}}" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of events to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The state of the protection check. Possible values are `pending`, `succeeded`, and `failed`.", "key": "state", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e5ba4f77-bf55-461d-80ae-6bf954de7e5a" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-01496c60-0847-4fee-86cf-0a3a30746ee6" } ], "id": "38ecf1bc-d257-4a90-8eb8-23f82567020d", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-38ecf1bc-d257-4a90-8eb8-23f82567020d" }, { "name": "events", "item": [ { "name": "{event_token}.json", "item": [ { "name": "Show protection check", "id": "922a05d1-68da-4c88-97b4-eb8b4ad1efa9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/protection/events/{{event_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events", "{{event_token}}.json" ] }, "description": "Get a protection check event with the given token." }, "response": [ { "id": "75c96454-42ec-48ef-952b-01cd76db57db", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events/{{event_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events", "{{event_token}}.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"event\": {\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"fraud_control_vendor_key\": \"\",\n \"vendor_transaction_id\": \"\",\n \"order_id\": \"\",\n \"protection_provider_key\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"ip\": \"\",\n \"email\": \"\",\n \"callback_url\": \"\",\n \"test_scenario\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"exemption_type\": \"\",\n \"warning\": \"\",\n \"managed_order_token\": \"\",\n \"fraud_decision\": \"\",\n \"fraud_recommendation\": \"\",\n \"fraud_decision_reason\": \"\",\n \"vendor_response\": {\n \"forterDecision\": \"\",\n \"recommendation\": \"\",\n \"verificationMethod\": {},\n \"decisionReason\": \"\",\n \"merchantPolicyId\": \"\",\n \"orderId\": \"\",\n \"linkToEventInDashboard\": \"\"\n },\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"sca_provider_key\": \"\",\n \"acs_transaction_id\": \"\",\n \"three_ds_server_trans_id\": \"\",\n \"directory_server_transaction_id\": \"\",\n \"xid\": \"\",\n \"three_ds_version\": \"\",\n \"flow_performed\": \"\",\n \"ecommerce_indicator\": \"\",\n \"directory_response_status\": \"\",\n \"authentication_response_status\": \"\",\n \"authentication_value\": \"\",\n \"trans_status_reason\": \"\",\n \"daf\": \"\",\n \"payment_method_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-75c96454-42ec-48ef-952b-01cd76db57db" }, { "id": "c1feb001-683c-483f-85f1-bfca8d5ae89f", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/events/{{event_token}}.json", "host": [ "{{baseUrl}}" ], "path": [ "protection", "events", "{{event_token}}.json" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-c1feb001-683c-483f-85f1-bfca8d5ae89f" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-922a05d1-68da-4c88-97b4-eb8b4ad1efa9" } ], "id": "a94d1e2d-dc0d-453d-a25d-cf1b69dc211b", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a94d1e2d-dc0d-453d-a25d-cf1b69dc211b" } ], "id": "a3ef6428-3439-4e69-a06c-ac5cfe2b61f2", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a3ef6428-3439-4e69-a06c-ac5cfe2b61f2" }, { "name": "providers", "item": [ { "name": "{protection_provider_token}", "item": [ { "name": "Show protection provider", "id": "72a52732-ae5b-401b-beb4-ea40e41ac8a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/protection/providers/:protection_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers", ":protection_provider_token" ], "variable": [ { "id": "3bb476c2-ef38-4928-9cd5-6441e73a4c2d", "key": "protection_provider_token", "value": "", "description": "(Required) The token of the Protection Provider" } ] }, "description": "Get a Protection Provider with the given token. A Protection Provider can be used as part of [authorize](https://developer.spreedly.com/reference/authorize), [purchase](https://developer.spreedly.com/reference/purchase), and [verify](https://developer.spreedly.com/reference/verify) transactions." }, "response": [ { "id": "ddcb3871-af29-430b-9888-f716a84ab4f8", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/providers/:protection_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers", ":protection_provider_token" ], "variable": [ { "key": "protection_provider_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"protection_provider\": {\n \"token\": \"\",\n \"three_ds_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ddcb3871-af29-430b-9888-f716a84ab4f8" }, { "id": "effd1447-d496-40db-8121-63026650c1e0", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/providers/:protection_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers", ":protection_provider_token" ], "variable": [ { "key": "protection_provider_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-effd1447-d496-40db-8121-63026650c1e0" }, { "id": "689cd6b1-0fe5-4eba-b7c4-cd7c9dd70a32", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/protection/providers/:protection_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers", ":protection_provider_token" ], "variable": [ { "key": "protection_provider_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-689cd6b1-0fe5-4eba-b7c4-cd7c9dd70a32" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-72a52732-ae5b-401b-beb4-ea40e41ac8a4" } ], "id": "7ad31b47-7399-4b8e-b5eb-e4f6bca1975e", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7ad31b47-7399-4b8e-b5eb-e4f6bca1975e" }, { "name": "Create a protection provider on the given merchant profile", "id": "f72317f9-1ee2-4fae-a6b9-5530ffc4b260", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"three_ds_enabled\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/providers", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers" ] }, "description": "Create a Protection Provider on the given Merchant Profile. A Protection Provider can be used as part of [authorize](https://developer.spreedly.com/reference/authorize), [purchase](https://developer.spreedly.com/reference/purchase), and [verify](https://developer.spreedly.com/reference/verify) transactions. **At least one card type object must be included in the request.** The following card types are supported: `Visa`, `Mastercard`, `American Express`, `Discover`, `Diners`, `JCB`, `Dankort`, `Union Pay`, and `Cartes Bancaires`." }, "response": [ { "id": "62c0bd7b-68bf-4108-a4ce-cca69a45414f", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"three_ds_enabled\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/providers", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"protection_provider\": {\n \"token\": \"\",\n \"three_ds_enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-62c0bd7b-68bf-4108-a4ce-cca69a45414f" }, { "id": "4da4d0a0-7b88-45dc-83f4-67ca6ea8052b", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"three_ds_enabled\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/providers", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-4da4d0a0-7b88-45dc-83f4-67ca6ea8052b" }, { "id": "de765d9b-cd72-43d2-8417-4de0dc4a262b", "name": "Unprocessable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"three_ds_enabled\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"diners\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"jcb\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"dankort\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"union_pay\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"cartes_bancaires\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/protection/providers", "host": [ "{{baseUrl}}" ], "path": [ "protection", "providers" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-de765d9b-cd72-43d2-8417-4de0dc4a262b" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f72317f9-1ee2-4fae-a6b9-5530ffc4b260" } ], "id": "3e940eec-1437-433b-8f58-1bfc6ce6d3d3", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3e940eec-1437-433b-8f58-1bfc6ce6d3d3" } ], "id": "19139a80-0310-443f-bf8d-c20445c918d5", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-19139a80-0310-443f-bf8d-c20445c918d5" }, { "name": "receivers_options", "item": [ { "name": "List supported receivers", "id": "44c3233d-f1a6-4860-83fe-f3e7842a5208", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivers_options", "host": [ "{{baseUrl}}" ], "path": [ "receivers_options" ] }, "description": "Retrieve a list of all payment method distribution receivers, and their properties, supported by Spreedly.\n\nNote that this request is publicly available and _does not require authorization_.\n" }, "response": [ { "id": "05fc9af5-2ef8-4782-865f-a79a0b6a98fa", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivers_options", "host": [ "{{baseUrl}}" ], "path": [ "receivers_options" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receivers\": [\n {\n \"name\": \"\",\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"company_name\": \"\"\n },\n {\n \"name\": \"\",\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"company_name\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-05fc9af5-2ef8-4782-865f-a79a0b6a98fa" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-44c3233d-f1a6-4860-83fe-f3e7842a5208" } ], "id": "27781dde-14aa-4f10-881e-00d2c2c137dc", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-27781dde-14aa-4f10-881e-00d2c2c137dc" }, { "name": "receivers", "item": [ { "name": "{receiver_token}", "item": [ { "name": "redact", "item": [ { "name": "Redact a receiver", "id": "8a006647-02f6-453c-bb9f-21cd47157ddd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "redact" ], "variable": [ { "id": "cc64c7b4-abe3-4573-a797-718da8f8cd59", "key": "receiver_token", "value": "", "description": "(Required) The token of the receiver at Spreedly" } ] }, "description": "Redact (strip of any sensitive credentials and make inactive) a receiver." }, "response": [ { "id": "2ed0e2d7-0c37-4038-8ea9-e18d53a6a9dc", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "redact" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2ed0e2d7-0c37-4038-8ea9-e18d53a6a9dc" }, { "id": "ce1796e1-e025-4df2-948c-c3ceddac221d", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "redact" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ce1796e1-e025-4df2-948c-c3ceddac221d" }, { "id": "2f2a9577-7063-413c-a203-030486464721", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/redact", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "redact" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-2f2a9577-7063-413c-a203-030486464721" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8a006647-02f6-453c-bb9f-21cd47157ddd" } ], "id": "df430cb1-c74a-4034-91aa-80adf8eeb3cd", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-df430cb1-c74a-4034-91aa-80adf8eeb3cd" }, { "name": "deliver", "item": [ { "name": "Deliver payment method", "id": "c34a24bc-57af-4b79-baa2-4024fcbb80b9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"delivery\": {\n \"payment_method_token\": \"\",\n \"url\": \"\",\n \"body\": \"\",\n \"continue_caching\": \"\",\n \"attempt_network_token\": \"\",\n \"request_method\": \"\",\n \"headers\": \"\",\n \"encode_response\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/deliver", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "deliver" ], "variable": [ { "id": "2c57a7a4-af3e-45c5-b214-eb0d853438ac", "key": "receiver_token", "value": "", "description": "(Required) The token of the receiver at Spreedly" } ] }, "description": "Deliver a payment method to the specified receiver endpoint. See the guide on [payment method distribution](https://developer.spreedly.com/docs/payment-method-distribution) to understand how to specify what is sent to the receiver. Spreedly provides an open [repository of code templates](https://github.com/spreedly/templates) for simplifying implementation of new receivers." }, "response": [ { "id": "fb504c9e-a1cd-4387-ab02-81c0a5141348", "name": "Successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"delivery\": {\n \"payment_method_token\": \"\",\n \"url\": \"\",\n \"body\": \"\",\n \"continue_caching\": \"\",\n \"attempt_network_token\": \"\",\n \"request_method\": \"\",\n \"headers\": \"\",\n \"encode_response\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/deliver", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "deliver" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"sub_merchant_key\": \"\",\n \"url\": \"\",\n \"deliver_time_ms\": \"\",\n \"response\": {\n \"status\": \"\",\n \"headers\": \"\",\n \"body\": \"\"\n },\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n },\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fb504c9e-a1cd-4387-ab02-81c0a5141348" }, { "id": "44e6c45e-7f0d-432f-b7cd-2abc7035fffe", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"delivery\": {\n \"payment_method_token\": \"\",\n \"url\": \"\",\n \"body\": \"\",\n \"continue_caching\": \"\",\n \"attempt_network_token\": \"\",\n \"request_method\": \"\",\n \"headers\": \"\",\n \"encode_response\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/deliver", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "deliver" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-44e6c45e-7f0d-432f-b7cd-2abc7035fffe" }, { "id": "0a0338ff-eb55-4d96-b6f9-cafe87797b85", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Receiver not found" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"delivery\": {\n \"payment_method_token\": \"\",\n \"url\": \"\",\n \"body\": \"\",\n \"continue_caching\": \"\",\n \"attempt_network_token\": \"\",\n \"request_method\": \"\",\n \"headers\": \"\",\n \"encode_response\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/deliver", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "deliver" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Receiver not found" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.receiver_not_found\",\n \"message\": \"Unable to find the specified receiver.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n Unable to find the specified receiver.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0a0338ff-eb55-4d96-b6f9-cafe87797b85" }, { "id": "22ce39ef-92ea-4870-9d6f-d32da753de09", "name": "Unknown error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"delivery\": {\n \"payment_method_token\": \"\",\n \"url\": \"\",\n \"body\": \"\",\n \"continue_caching\": \"\",\n \"attempt_network_token\": \"\",\n \"request_method\": \"\",\n \"headers\": \"\",\n \"encode_response\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/deliver", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "deliver" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"sub_merchant_key\": \"\",\n \"url\": \"\",\n \"deliver_time_ms\": \"\",\n \"response\": {\n \"status\": \"\",\n \"headers\": \"\",\n \"body\": \"\"\n },\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n },\n \"payment_method\": {\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"email\": \"\",\n \"storage_state\": \"\",\n \"test\": \"\",\n \"metadata\": {},\n \"callback_url\": \"\",\n \"last_four_digits\": \"\",\n \"first_six_digits\": \"\",\n \"card_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"month\": \"\",\n \"year\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"phone_number\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"eligible_for_card_updater\": \"\",\n \"shipping_address1\": \"\",\n \"shipping_address2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"\",\n \"issuer_identification_number\": \"\",\n \"click_to_pay\": \"\",\n \"managed\": \"\",\n \"payment_method_type\": \"\",\n \"errors\": \"\",\n \"fingerprint\": \"\",\n \"verification_value\": \"\",\n \"number\": \"\",\n \"bin_metadata\": {\n \"card_brand\": \"\",\n \"card_category\": \"\",\n \"card_type\": \"\",\n \"issuing_bank\": \"\",\n \"issuing_country_iso_number\": \"\",\n \"issuing_country_iso_a2_code\": \"\",\n \"issuing_country_iso_a3_code\": \"\",\n \"issuing_country_iso_name\": \"\",\n \"issuing_bank_phone_number\": \"\",\n \"issuing_bank_website\": \"\",\n \"bin_type\": \"\",\n \"regulated\": \"\",\n \"max_pan_length\": \"\",\n \"message\": \"\"\n },\n \"subscribed_to_mastercard_abu\": \"\",\n \"last_successfully_used\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-22ce39ef-92ea-4870-9d6f-d32da753de09" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-c34a24bc-57af-4b79-baa2-4024fcbb80b9" } ], "id": "514dad53-30c2-4263-86ff-0ddf090f227a", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-514dad53-30c2-4263-86ff-0ddf090f227a" }, { "name": "export", "item": [ { "name": "Export payment methods", "id": "2ea22af6-420a-4fea-8fa3-1e7990b8cf8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"export\": {\n \"payment_method_tokens\": [\n \"\",\n \"\"\n ],\n \"payment_method_data\": {},\n \"url\": \"\",\n \"body\": \"\",\n \"callback_url\": \"\",\n \"sub_merchant_key\": \"\"\n },\n \"payment_method_tokens\": \"consectetur non\",\n \"url\": 24877809.22112055\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/export", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "export" ], "variable": [ { "id": "60cd0488-22b5-4f32-b16a-f81d2b93bd61", "key": "receiver_token", "value": "", "description": "(Required) The token of the receiver at Spreedly" } ] }, "description": "Export multiple payment methods in a single, asynchronous, batch call to an SFTP receiver endpoint." }, "response": [ { "id": "0d5ee06d-1c82-4d6e-977b-effda751c2c0", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"export\": {\n \"payment_method_tokens\": [\n \"\",\n \"\"\n ],\n \"payment_method_data\": {},\n \"url\": \"\",\n \"body\": \"\",\n \"callback_url\": \"\",\n \"sub_merchant_key\": \"\"\n },\n \"payment_method_tokens\": \"consectetur non\",\n \"url\": 24877809.22112055\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/export", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "export" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"transaction_type\": \"\",\n \"state\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"payment_methods_submitted\": \"\",\n \"payment_method_data\": {},\n \"payment_methods_included\": \"\",\n \"encode_response\": \"\",\n \"callback_url\": \"\",\n \"url\": \"\",\n \"payment_methods_excluded\": {},\n \"response\": \"\",\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0d5ee06d-1c82-4d6e-977b-effda751c2c0" }, { "id": "28123cc5-5362-4013-a7e5-c3e03110f8f4", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"export\": {\n \"payment_method_tokens\": [\n \"\",\n \"\"\n ],\n \"payment_method_data\": {},\n \"url\": \"\",\n \"body\": \"\",\n \"callback_url\": \"\",\n \"sub_merchant_key\": \"\"\n },\n \"payment_method_tokens\": \"consectetur non\",\n \"url\": 24877809.22112055\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token/export", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token", "export" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-28123cc5-5362-4013-a7e5-c3e03110f8f4" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-2ea22af6-420a-4fea-8fa3-1e7990b8cf8a" } ], "id": "7e8b0ea1-dc4e-40a5-ac4b-ade7e2e9f377", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-7e8b0ea1-dc4e-40a5-ac4b-ade7e2e9f377" }, { "name": "Show a receiver", "id": "fe669b95-e7e4-4b3f-81c6-2ca3af09f154", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "id": "e9def38d-6e3b-4aa6-993b-bd407d134103", "key": "receiver_token", "value": "", "description": "(Required) The token of the receiver at Spreedly" } ] }, "description": "Get a receiver with the given token" }, "response": [ { "id": "0a2ed3f3-26b5-434f-8c87-b7bcc2307576", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-0a2ed3f3-26b5-434f-8c87-b7bcc2307576" }, { "id": "5a5ef60d-1bf4-44b4-9fd0-ea6630ec34e2", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5a5ef60d-1bf4-44b4-9fd0-ea6630ec34e2" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-fe669b95-e7e4-4b3f-81c6-2ca3af09f154" }, { "name": "Update a receiver", "id": "69800b84-7844-41dc-bb33-8b798f114483", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "id": "074307a5-f20a-425d-99fb-b33897d8c4e1", "key": "receiver_token", "value": "", "description": "(Required) The token of the receiver at Spreedly" } ] }, "description": "Update a receiver with new credentials" }, "response": [ { "id": "813e2509-0e89-4bf7-ad66-e1ca441866f3", "name": "Successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-813e2509-0e89-4bf7-ad66-e1ca441866f3" }, { "id": "d9b56bc9-57c1-4814-9b4e-5ed59fb7a4c1", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-d9b56bc9-57c1-4814-9b4e-5ed59fb7a4c1" }, { "id": "fc4ebcf8-b0a9-483a-9ddd-7693a72e053e", "name": "Unknown error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers/:receiver_token", "host": [ "{{baseUrl}}" ], "path": [ "receivers", ":receiver_token" ], "variable": [ { "key": "receiver_token" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-fc4ebcf8-b0a9-483a-9ddd-7693a72e053e" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-69800b84-7844-41dc-bb33-8b798f114483" } ], "id": "25b1d954-14bc-421d-a434-643d30ba0c8f", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-25b1d954-14bc-421d-a434-643d30ba0c8f" }, { "name": "Create a receiver", "id": "24db32ac-fabe-456e-9f33-1b6464041840", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ] }, "description": "Create a receiver for use in [payment method distribution](https://developer.spreedly.com/docs/payment-method-distribution)" }, "response": [ { "id": "a38693ab-a68a-454a-acc9-e85942687612", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receiver\": {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a38693ab-a68a-454a-acc9-e85942687612" }, { "id": "889ab401-f6d0-4c70-9bde-6430abbfd734", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-889ab401-f6d0-4c70-9bde-6430abbfd734" }, { "id": "73a857b5-8879-4423-abbc-15b8e5bb487e", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"receiver\": {\n \"receiver_type\": \"\",\n \"hostnames\": \"\",\n \"credentials\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"safe\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/receivers", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-73a857b5-8879-4423-abbc-15b8e5bb487e" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-24db32ac-fabe-456e-9f33-1b6464041840" }, { "name": "List created receivers", "id": "d14159e9-e1ac-4f09-8925-351f20df39eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivers?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ] }, "description": "Retrieve an [ordered and paginated](https://developer.spreedly.com/reference/order-and-pagination) list of all receivers in the authenticated environment." }, "response": [ { "id": "cb35c6ba-0152-4735-ac48-b23abd0c85a9", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"receivers\": [\n {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n },\n {\n \"company_name\": \"\",\n \"receiver_type\": \"\",\n \"state\": \"\",\n \"token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"credentials\": \"\",\n \"hostnames\": \"\",\n \"sub_merchant_key\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-cb35c6ba-0152-4735-ac48-b23abd0c85a9" }, { "id": "91af2ee0-cdf1-44f4-9a4c-308a97c1da3c", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/receivers?order=&since_token=", "host": [ "{{baseUrl}}" ], "path": [ "receivers" ], "query": [ { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" }, { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-91af2ee0-cdf1-44f4-9a4c-308a97c1da3c" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-d14159e9-e1ac-4f09-8925-351f20df39eb" } ], "id": "e45e2cf6-66ce-4257-82ff-4931da62da5b", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-e45e2cf6-66ce-4257-82ff-4931da62da5b" }, { "name": "sca", "item": [ { "name": "providers", "item": [ { "name": "{sca_provider_key}", "item": [ { "name": "authenticate", "item": [ { "name": "Authenticate a given payment method", "id": "1d4f7e66-053a-4cbe-b729-f6b768309bd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"browser_info\": \"\",\n \"currency_code\": \"\",\n \"amount\": \"\",\n \"test_scenario\": {\n \"scenario\": \"\"\n },\n \"force_daf\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"three_ds_requestor_challenge_ind\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_key/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_key", "authenticate" ], "variable": [ { "id": "23d81d03-812b-445b-8f78-d52f87e748f1", "key": "sca_provider_key", "value": "", "description": "(Required) The token returned by the sca providers [endpoint](https://developer.spreedly.com/docs/3ds-solutions#creating-an-sca-provider)" } ] }, "description": "Authenticate a given payment method and amount against provided SCA Provider Key (specified in the request URL)\n\nNotable response elements can be found in the table below. All other response elements are used by our `Spreedly.ThreeDS.Lifecycle` helpers and exposed for debugging purposes. We recommend that our merchants not use any fields that are not listed in the table below.\n" }, "response": [ { "id": "1904c415-bfcf-4b5d-86c2-fbe22036fa44", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"browser_info\": \"\",\n \"currency_code\": \"\",\n \"amount\": \"\",\n \"test_scenario\": {\n \"scenario\": \"\"\n },\n \"force_daf\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"three_ds_requestor_challenge_ind\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_key/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_key", "authenticate" ], "variable": [ { "key": "sca_provider_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transaction\": {\n \"token\": \"\",\n \"succeeded\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"transaction_type\": \"\",\n \"gateway_transaction_key\": \"\",\n \"sca_provider_key\": \"\",\n \"acs_transaction_id\": \"\",\n \"three_ds_server_trans_id\": \"\",\n \"directory_server_transaction_id\": \"\",\n \"xid\": \"\",\n \"three_ds_version\": \"\",\n \"flow_performed\": \"\",\n \"ecommerce_indicator\": \"\",\n \"directory_response_status\": \"\",\n \"authentication_response_status\": \"\",\n \"authentication_value\": \"\",\n \"trans_status_reason\": \"\",\n \"daf\": \"\",\n \"managed_order_token\": \"\",\n \"payment_method_key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-1904c415-bfcf-4b5d-86c2-fbe22036fa44" }, { "id": "34ca2bed-5d81-4969-8dd5-456d48cfc1d8", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Not authorized request" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"browser_info\": \"\",\n \"currency_code\": \"\",\n \"amount\": \"\",\n \"test_scenario\": {\n \"scenario\": \"\"\n },\n \"force_daf\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"three_ds_requestor_challenge_ind\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_key/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_key", "authenticate" ], "variable": [ { "key": "sca_provider_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Not authorized request" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.access_denied\",\n \"message\": \"Unable to authenticate using the given environment_key and access_token. Please check your credentials.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n Unable to authenticate using the given environment_key and access_token. Please check your credentials.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-34ca2bed-5d81-4969-8dd5-456d48cfc1d8" }, { "id": "355cafd7-404e-4ce3-b131-5e7e4ebcbfae", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Token Not Found" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"browser_info\": \"\",\n \"currency_code\": \"\",\n \"amount\": \"\",\n \"test_scenario\": {\n \"scenario\": \"\"\n },\n \"force_daf\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"three_ds_requestor_challenge_ind\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_key/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_key", "authenticate" ], "variable": [ { "key": "sca_provider_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Token Not Found" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.sca_provider_not_found\",\n \"message\": \"Unable to find the sca_provider given.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n Unable to find the sca_provider given.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-355cafd7-404e-4ce3-b131-5e7e4ebcbfae" }, { "id": "a6bbb132-c678-4701-815c-0831b3488099", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Unprocessable Entity" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"payment_method_token\": \"\",\n \"browser_info\": \"\",\n \"currency_code\": \"\",\n \"amount\": \"\",\n \"test_scenario\": {\n \"scenario\": \"\"\n },\n \"force_daf\": \"\",\n \"exemption_type\": \"\",\n \"acquiring_bank_fraud_rate\": \"\",\n \"three_ds_requestor_challenge_ind\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_key/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_key", "authenticate" ], "variable": [ { "key": "sca_provider_key" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Unprocessable Entity" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.payment_method_or_payment_method_token_required\",\n \"message\": \"You must specify a valid 'payment_method' or valid 'payment_method_token' parameter.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n You must specify a valid 'payment_method' or valid 'payment_method_token' parameter.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a6bbb132-c678-4701-815c-0831b3488099" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-1d4f7e66-053a-4cbe-b729-f6b768309bd0" } ], "id": "4f0be225-e2a5-4d8f-8460-516b5a33b763", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4f0be225-e2a5-4d8f-8460-516b5a33b763" } ], "id": "6093b420-c2e4-47d7-b4b5-857467dd54c9", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-6093b420-c2e4-47d7-b4b5-857467dd54c9" }, { "name": "{sca_provider_token}", "item": [ { "name": "Show sca provider", "id": "8e50d94d-27f3-43d8-ab3c-b25ac4321216", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_token" ], "variable": [ { "id": "ff1b84d5-47ef-49ca-b722-1322f2c45bdc", "key": "sca_provider_token", "value": "", "description": "(Required) The token of the SCA Provider" } ] }, "description": "Get an SCA Provider with the given token. An SCA Provider can be used to run [3DS2 Global](https://developer.spreedly.com/docs/3ds-solutions) authentications on the [authenticate](https://developer.spreedly.com/reference/authenticate) endpoint or as part of [authorize](https://developer.spreedly.com/reference/authorize-1) and [purchase](https://developer.spreedly.com/reference/reference-purchase) transactions." }, "response": [ { "id": "5b100922-4624-40c7-a96a-26492b315758", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_token" ], "variable": [ { "key": "sca_provider_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sca_provider\": {\n \"token\": \"\",\n \"sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-5b100922-4624-40c7-a96a-26492b315758" }, { "id": "97c4f1cf-762f-4627-9d5b-0b7f3651db55", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_token" ], "variable": [ { "key": "sca_provider_token" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-97c4f1cf-762f-4627-9d5b-0b7f3651db55" }, { "id": "e2a883bb-a813-4a89-b065-b0878a27174d", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sca/providers/:sca_provider_token", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers", ":sca_provider_token" ], "variable": [ { "key": "sca_provider_token" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e2a883bb-a813-4a89-b065-b0878a27174d" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-8e50d94d-27f3-43d8-ab3c-b25ac4321216" } ], "id": "b0b7518d-f109-42e3-ae97-7ed7132db8c4", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-b0b7518d-f109-42e3-ae97-7ed7132db8c4" }, { "name": "Create an sca provider on the given merchant profile", "id": "aa479257-9f95-41be-a74f-4b8c73cd6f53", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"sandbox\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers" ] }, "description": "Create an SCA Provider on the given Merchant Profile. An SCA Provider can be used to run [3DS2 Global](https://developer.spreedly.com/docs/3ds-solutions) authentications on the [authenticate](https://developer.spreedly.com/reference/authenticate) endpoint or as part of [authorize](https://developer.spreedly.com/reference/authorize) and [purchase](https://developer.spreedly.com/reference/purchase) transactions. At least one card type object must be included in the request. The following card types are supported: `Visa`, `Mastercard`, `American Express`, and `Discover`." }, "response": [ { "id": "b48e2b26-7116-4a39-8332-346b7c3bd8d2", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"sandbox\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sca_provider\": {\n \"token\": \"\",\n \"sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"type\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b48e2b26-7116-4a39-8332-346b7c3bd8d2" }, { "id": "ff843507-788b-460d-abf7-2daf4415d415", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"sandbox\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ff843507-788b-460d-abf7-2daf4415d415" }, { "id": "d26c089d-d3dd-46bc-948a-c35a04ca0517", "name": "Unprocessable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"merchant_profile_key\": \"\",\n \"type\": \"\",\n \"sandbox\": \"\",\n \"visa\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\",\n \"merchant_brand_id\": \"\"\n },\n \"mastercard\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"amex\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n },\n \"discover\": {\n \"acquirer_bin\": \"\",\n \"merchant_url\": \"\",\n \"merchant_password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sca/providers", "host": [ "{{baseUrl}}" ], "path": [ "sca", "providers" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-d26c089d-d3dd-46bc-948a-c35a04ca0517" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-aa479257-9f95-41be-a74f-4b8c73cd6f53" } ], "id": "a14afc84-e931-4905-a4e5-dd4f807f2bae", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-a14afc84-e931-4905-a4e5-dd4f807f2bae" } ], "id": "3dd25c65-1313-46de-a4d2-bf6d88447545", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3dd25c65-1313-46de-a4d2-bf6d88447545" }, { "name": "sub_merchants", "item": [ { "name": "{sub_merchant_key}", "item": [ { "name": "Show sub_merchant", "id": "3b45f3b8-a49e-4d60-9019-cd925a59e4e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "id": "d56c8d44-4ab0-4a05-8f95-010a544efd20", "key": "sub_merchant_key", "value": "", "description": "(Required) The key of the sub-merchant to execute against" } ] }, "description": "Get the sub-merchant with the given key." }, "response": [ { "id": "f9c52a59-8319-4b12-be95-6ada374a62a8", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_merchant\": {\n \"token\": \"\",\n \"name\": \"\",\n \"environment_key\": \"\",\n \"organization_key\": \"\",\n \"merchant_url\": \"\",\n \"ein\": \"\",\n \"merchant_email\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": {\n \"card_network\": \"\",\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"merchant_data_id\": \"\"\n },\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f9c52a59-8319-4b12-be95-6ada374a62a8" }, { "id": "f1d17187-36fc-47eb-8bb6-50615abda622", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f1d17187-36fc-47eb-8bb6-50615abda622" }, { "id": "b55ed2ba-e76b-4d74-a950-cf3948993b21", "name": "Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b55ed2ba-e76b-4d74-a950-cf3948993b21" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-3b45f3b8-a49e-4d60-9019-cd925a59e4e5" }, { "name": "Update sub_merchant", "id": "4bc18914-55b5-4012-8569-f266d33f62cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "id": "d1129781-29df-49bd-b8a3-499426d56ca0", "key": "sub_merchant_key", "value": "", "description": "(Required) The key of the sub-merchant to execute against" } ] }, "description": "Update a sub-merchant" }, "response": [ { "id": "ec66ac89-8945-42eb-93a4-7ebe72657c67", "name": "successful", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_merchant\": {\n \"token\": \"\",\n \"name\": \"\",\n \"environment_key\": \"\",\n \"organization_key\": \"\",\n \"merchant_url\": \"\",\n \"ein\": \"\",\n \"merchant_email\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": {\n \"card_network\": \"\",\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"merchant_data_id\": \"\"\n },\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-ec66ac89-8945-42eb-93a4-7ebe72657c67" }, { "id": "f727563c-f52b-4027-b253-d404bc00c2bb", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f727563c-f52b-4027-b253-d404bc00c2bb" }, { "id": "3a07f08c-8053-43b6-8103-514e4c229a9b", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-3a07f08c-8053-43b6-8103-514e4c229a9b" }, { "id": "b9c643f0-2797-490f-836c-29256bee47ff", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Missing request parameter" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants/:sub_merchant_key", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants", ":sub_merchant_key" ], "variable": [ { "key": "sub_merchant_key" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Missing request parameter" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.merchant_data_acquirer_merchant_id_required\",\n \"message\": \"acquirer_merchant_id is required when using merchant_data.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n errors.merchant_data_acquirer_merchant_id_required\\n acquirer_merchant_id is required when using merchant_data.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-b9c643f0-2797-490f-836c-29256bee47ff" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-4bc18914-55b5-4012-8569-f266d33f62cc" } ], "id": "f579dfc6-41a5-4995-add0-db006f96aba0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-f579dfc6-41a5-4995-add0-db006f96aba0" }, { "name": "List sub_merchants", "id": "95c2ebb6-c4f1-46fe-92a5-7ec37818fcf4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_merchants?since_token=&count=&order=", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ], "query": [ { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of sub_merchants to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all Sub-merchants in an organization. This call should be authenticated with an environment key from the organization and an Organization Access Secret." }, "response": [ { "id": "53576ade-c62e-465b-b9ee-2ae65c6dfcc9", "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sub_merchants?since_token=&count=&order=", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ], "query": [ { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of sub_merchants to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_merchants\": [\n {\n \"token\": \"\",\n \"name\": \"\",\n \"environment_key\": \"\",\n \"organization_key\": \"\",\n \"merchant_url\": \"\",\n \"ein\": \"\",\n \"merchant_email\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": {\n \"card_network\": \"\",\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"merchant_data_id\": \"\"\n },\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"token\": \"\",\n \"name\": \"\",\n \"environment_key\": \"\",\n \"organization_key\": \"\",\n \"merchant_url\": \"\",\n \"ein\": \"\",\n \"merchant_email\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": {\n \"card_network\": \"\",\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"merchant_data_id\": \"\"\n },\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-53576ade-c62e-465b-b9ee-2ae65c6dfcc9" }, { "id": "a67aba7b-e500-414c-98f1-37a000871987", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/sub_merchants?since_token=&count=&order=", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ], "query": [ { "description": "The token of the item to start from (e.g., the last token received in the previous list if iterating through records)", "key": "since_token", "value": "" }, { "description": "The number of sub_merchants to return. By default returns 20, maximum allowed is 100.", "key": "count", "value": "" }, { "description": "The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.", "key": "order", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-a67aba7b-e500-414c-98f1-37a000871987" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-95c2ebb6-c4f1-46fe-92a5-7ec37818fcf4" }, { "name": "Create sub_merchant", "id": "313ff851-298a-4706-88fb-75a86b4ad0e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"environment_key\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ] }, "description": "Create a sub-merchant" }, "response": [ { "id": "f349259c-9d6b-49e7-8db0-e13496b0c99d", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"environment_key\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_merchant\": {\n \"token\": \"\",\n \"name\": \"\",\n \"environment_key\": \"\",\n \"organization_key\": \"\",\n \"merchant_url\": \"\",\n \"ein\": \"\",\n \"merchant_email\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": {\n \"card_network\": \"\",\n \"acquirer_merchant_id\": \"\",\n \"mcc\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"merchant_data_id\": \"\"\n },\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-f349259c-9d6b-49e7-8db0-e13496b0c99d" }, { "id": "50d47a29-ed63-44d9-ab95-dd0d895a5bc2", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"environment_key\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n },\n {\n \"key\": \"\",\n \"message\": \"\",\n \"attribute\": \"\"\n }\n]", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-50d47a29-ed63-44d9-ab95-dd0d895a5bc2" }, { "id": "e654c2ee-19e7-4991-ac70-fd80e86799af", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "Missing request parameter" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"sub_merchant\": {\n \"name\": \"\",\n \"environment_key\": \"\",\n \"merchant_url\": \"\",\n \"merchant_email\": \"\",\n \"ein\": \"\",\n \"merchant_defined_uid\": \"\",\n \"merchant_data\": [\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n },\n {\n \"acquirer_merchant_id\": \"\",\n \"card_network\": \"\",\n \"acquirer_bin\": \"\",\n \"business_id\": \"\",\n \"mcc\": \"\"\n }\n ],\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"country\": \"\"\n },\n \"metadata\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_merchants", "host": [ "{{baseUrl}}" ], "path": [ "sub_merchants" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "Missing request parameter" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"application/json\": {\n \"value\": [\n {\n \"key\": \"errors.merchant_data_acquirer_merchant_id_required\",\n \"message\": \"acquirer_merchant_id is required when using merchant_data.\"\n }\n ]\n },\n \"application/xml\": {\n \"value\": \" \\n errors.merchant_data_acquirer_merchant_id_required\\n acquirer_merchant_id is required when using merchant_data.\\n \\n\"\n }\n }\n}", "createdAt": "2026-07-28T03:01:36.000Z", "updatedAt": "2026-07-28T03:01:36.000Z", "uid": "35240-e654c2ee-19e7-4991-ac70-fd80e86799af" } ], "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-313ff851-298a-4706-88fb-75a86b4ad0e2" } ], "id": "370649c9-4287-4ac4-a8a8-d31879e1fdb0", "createdAt": "2026-07-28T03:01:35.000Z", "updatedAt": "2026-07-28T03:01:35.000Z", "uid": "35240-370649c9-4287-4ac4-a8a8-d31879e1fdb0" } ], "variable": [ { "key": "baseUrl", "value": "https://core.spreedly.com/v1" }, { "key": "gateway_token", "value": "" }, { "key": "format", "value": "json" }, { "key": "payment_method_token", "value": "" }, { "key": "event_token", "value": "" } ] }