Cards

Simulate refund

Simulate a merchandise return against a settled card transaction. Each call creates a new refund transaction linked to the purchase by original_card_transaction_id, and the total refunded must not exceed the settled amount.

post/simulate/issuing/card-transactions/{card_transaction_id}/refund

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/simulate/issuing/card-transactions/{card_transaction_id}/refund
  • Auth: HTTP basic

Path parameters

card_transaction_idstring required

Request body

cardholder_amountinteger required

Amount to refund, expressed in the smallest currency unit (e.g., cents for USD). Must not exceed the remaining refundable amount on the original transaction. Must not exceed 999999999999.

Example request

{
  "cardholder_amount": 1000
}

Response

Successful response

authorization_expires_atstring date-time nullable

The authorization expiration date of the card transaction. Funds will be released from any authorization after this date

card_account_idstring required

The ID of the card account

card_idstring required

The ID of the card

card_program_idstring required

The ID of the card program

card_token_idstring nullable

The card token used for this transaction, if applicable.

created_atstring date-time required

The creation date of the card transaction

idstring required

The ID of the card transaction

network_transaction_idstring nullable

The transaction ID assigned by the card network

original_card_transaction_idstring nullable

The ID of the original card transaction referenced by the transaction

type'unknown' | 'purchase' | 'cash_withdrawal' | 'quasi_cash' | 'account_funding' | 'bill_payment' | 'adjustment' | 'refund' | 'original_credit' | 'balance_inquiry' | 'account_verification' required

The kind of card transaction, set from the card network processing code when the transaction is created. Unlike event_type, which describes each step of the transaction lifecycle, the type does not change. Combine it with point_of_sale_details.terminal_type to distinguish, for example, an ATM withdrawal (cash_withdrawal at an atm) from a cash advance at a bank teller. unknown is returned when the network did not identify the kind. Possible values: unknown, purchase, cash_withdrawal, quasi_cash, account_funding, bill_payment, adjustment, refund, original_credit, balance_inquiry, account_verification

Example response

{
  "authentication_details": {
    "three_ds_attempt_id": "tdsa_2x8gszy5folpA9s0TOCseE9ABDM"
  },
  "card_acceptor_details": {
    "acquiring_institution_country_code": "US",
    "country_code": "US",
    "name": "Yellen Cocktails, LLC"
  },
  "card_account_id": "cacc_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_id": "card_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_program_id": "cpgm_2x8gszy5folpA9s0TOCseE9ABDM",
  "card_token_id": "ctkn_2x8gszy5folpA9s0TOCseE9ABDM",
  "events": [
    {
      "amounts": {
        "cardholder_authorized": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        },
        "cardholder_requested": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        },
        "cardholder_settled": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        },
        "merchant_authorized": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        },
        "merchant_requested": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        },
        "merchant_settled": {
          "amount": 12345,
          "currency_code": "USD",
          "fx_rate": "1.0842"
        }
      },
      "authentication_attempt_id": "caat_2x8gszy5folpA9s0TOCseE9ABDM",
      "card_account_id": "cacc_2x8gszy5folpA9s0TOCseE9ABDM",
      "card_id": "card_2x8gszy5folpA9s0TOCseE9ABDM",
      "card_program_id": "cpgm_2x8gszy5folpA9s0TOCseE9ABDM",
      "card_token_id": "ctkn_2x8gszy5folpA9s0TOCseE9ABDM",
      "decisioning_details": {
        "card_authorization_policy_evaluations": [
          {
            "card_authorization_policy_id": "caup_2x8gszy5folpA9s0TOCseE9ABDM",
            "card_authorization_policy_version_id": "cauv_2x8gszy5folpA9s0TOCseE9ABDM"
          }
        ],
        "funding_account_id": "bacc_2x8gszy5folpA9s0TOCseE9ABDM",
        "realtime_authorization_decision": "approve"
      },
      "id": "ctxe_2x8gszy5folpA9s0TOCseE9ABDM"
    }
  ],
  "fee_details": {
    "transaction_fee_currency": "USD"
  },
  "funding_details": {
    "currency_code": "USD",
    "funded_amount": 2500,
    "funding_account_id": "bacc_2x8gszy5folpA9s0TOCseE9ABDM"
  },
  "id": "ctxn_2x8gszy5folpA9s0TOCseE9ABDM",
  "network_details": {
    "network_fraud_score": 12,
    "network_identifier": "visa"
  },
  "network_transaction_id": "305123456789012",
  "original_card_transaction_id": "ctxn_2x8gszy5folpA9s0TOCseE9ABDM",
  "point_of_sale_details": {
    "card_presence": "present",
    "cardholder_presence": "present",
    "pan_entry_mode": "contactless_chip",
    "terminal_type": "atm",
    "transaction_initiator": "cardholder"
  },
  "recurring_transaction_details": {
    "recurring_original_transaction_id": "ctxn_2x8gszy5folpA9s0TOCseE9ABDM"
  },
  "total_amounts": {
    "cardholder_authorized": {
      "amount": 12345,
      "currency_code": "USD",
      "fx_rate": "1.0842"
    },
    "cardholder_settled": {
      "amount": 12345,
      "currency_code": "USD",
      "fx_rate": "1.0842"
    },
    "merchant_authorized": {
      "amount": 12345,
      "currency_code": "USD",
      "fx_rate": "1.0842"
    },
    "merchant_settled": {
      "amount": 12345,
      "currency_code": "USD",
      "fx_rate": "1.0842"
    }
  },
  "transaction_details": {
    "account_funding_data": {
      "payment_facilitator_name": "Acme Payments",
      "type": "account_to_account"
    },
    "fleet": {
      "fleet_fuel_information": {
        "quantity": "12.5",
        "unit_price": "3.65"
      },
      "item_sequence_number": 1,
      "motor_fuel_information": {
        "quantity": "12.5",
        "unit_price": "3.65"
      },
      "motor_fuel_service_type": "S",
      "odometer": "45210",
      "prompted_data": [
        {
          "prompt_code": "ODOM",
          "value": "45210"
        }
      ],
      "pump_number": "04"
    },
    "invoice_line_items": [
      {
        "debit_credit_indicator": "D",
        "extended_item_amount": "25.00",
        "fleet_extended_item_amount": "45.63",
        "fleet_item_description": "Unleaded fuel",
        "fleet_item_quantity": "12.5",
        "fleet_item_unit_of_measure": "GLL",
        "fleet_product_code": "001",
        "item_sequence_number": 1,
        "line_item_total": 2500,
        "quantity": "2",
        "unit_cost": "12.50",
        "vat_tax_rate": "8.25"
      }
    ],
    "invoice_summary": {
      "acceptor_tax_id": "12-3456789",
      "acceptor_type": "01",
      "item_sequence_number": 1
    },
    "lodging_data": {
      "daily_room_rate": 18900,
      "food_beverage_charges": 3000,
      "room_nights": 2,
      "total_charged": 44202,
      "total_charges": 44202,
      "total_non_room_charges": 3000,
      "total_room_tax": 3402,
      "total_tax": 3402
    },
    "original_credit_data": {
      "type": "person_to_person"
    },
    "travel_itinerary": {
      "item_sequencing_field": "1",
      "passenger_name": "Oliver Hockey"
    },
    "travel_legs": [
      {
        "control_id": "CTL0001",
        "item_sequencing_field": "1"
      }
    ]
  },
  "type": "purchase"
}

Changes

No recorded changes to this operation across all 1 revision of this API.