Sign in

v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

Retrieve a Declined Transaction

get/declined_transactions/{declined_transaction_id}

Path parameters

declined_transaction_idstring required

The identifier of the Declined Transaction.

Response

Declined Transaction

account_idstring required

The identifier for the Account the Declined Transaction belongs to.

amountinteger required

The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

created_atstring date-time required

The ISO 8601 date on which the Transaction occurred.

currency'USD' required

The ISO 4217 code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.

descriptionstring required

This is the description the vendor provides.

idstring required

The Declined Transaction identifier.

route_idstring nullable required

The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.

route_type'account_number' | 'card' | 'lockbox' nullable required

The type of the route this Declined Transaction came through.

type'declined_transaction' required

A constant representing the object's type. For this resource it will always be declined_transaction.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 1750,
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "description": "INVOICE 2468",
  "id": "declined_transaction_17jbn0yyhvkt4v4ooym8",
  "route_id": "account_number_v18nkfqm6afpsrvy82b2",
  "route_type": "account_number",
  "source": {
    "ach_decline": {
      "amount": 1750,
      "id": "ach_decline_72v1mcwxudctq56efipa",
      "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev",
      "originator_company_descriptive_date": null,
      "originator_company_discretionary_data": null,
      "originator_company_id": "0987654321",
      "originator_company_name": "BIG BANK",
      "reason": "insufficient_funds",
      "receiver_id_number": "12345678900",
      "receiver_name": "IAN CREASE",
      "trace_number": "021000038461022",
      "type": "ach_decline"
    },
    "category": "ach_decline"
  },
  "type": "declined_transaction"
}