Resources

Wire Payment

WirePayment is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the wire payment resource.
type	string	Type of the payment resource. The value is always `wirePayment`.
attributes	JSON Object	JSON object representing the payment resource.
relationships	JSON:API Relationships	Describes relationships between the Wire payment and the originating deposit account, customer and transaction.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
status	string	Either `Pending`, `Returned`, `Sent` , `Canceled` or `Rejected` (see `reason` for details).
reason Optional	string	Optional. More information about the status.
direction	string	The direction in which the funds flow (`Credit` only).
description	string	Payment description (maximum of 50 characters), this will show up on statement of the counterparty.
counterparty	Wire Counterparty	The beneficiary party on the other end of the payment.
amount	string	The amount (cents) of the payment.
tags	object	See Tags.
imadOmad	object	(Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account creating the payment.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
transaction	JSON:API Relationship	The Wire Transaction generated by this payment.
wireDrawdown	Optional, JSON:API Relationship	In case of drawdown payment, the related Wire Drawdown.

Example WirePayment resource:
{
  "data": {
    "type": "wirePayment",
    "id": "3",
    "attributes": {
      "createdAt": "2021-10-05T06:33:45.035Z",
      "amount": 200,
      "direction": "Credit",
      "description": "Wire payment",
      "counterparty": {
        "name": "April Oniel",
        "routingNumber": "812345678",
        "accountNumber": "1000000001",
        "address": {
          "street": "20 Ingram St",
          "city": "Forest Hills",
          "state": "CA",
          "postalCode": "11375",
          "country": "US"
        }
      },
      "status": "Sent",
      "imadOmad": {
        "imad": "123456",
        "omad": "654321"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10000"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "customers": {
        "data": [
          {
            "type": "customer",
            "id": "10000"
          }
        ]
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "1"
        }
      }
    }
  }
}

Wire Transaction

WireTransaction is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `wireTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
imadOmad	object	(Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.
counterparty	Counterparty	The party on the other end of the transaction, either the beneficiary or the originator.
description Optional	string	Optional. Description of the transaction as entered by the originator.
originatorToBeneficiaryInformation	string	Originator To Beneficiary Information, multi-line string delimited by `\n`.
senderReference	string	Sender reference.
referenceForBeneficiary	string	Reference for the Beneficiary.
beneficiaryInformation	string	Beneficiary Information, multi-line string delimited by `\n`.
beneficiaryAdviceInformation	string	Beneficiary Advice Information, multi-line string delimited by `\n`.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.

Example WireTransaction resource:
{
  "type": "wireTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Wire to Jane Smith",
    "imadOmad": {
      "imad": "123456",
      "omad": "654321"
    },
    "counterparty": {
      "name": "Jane Smith",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    }
  }
}

Wire Received Payment

WireReceivedPayment is a JSON:API resource, top-level fields:

Name	Type	Description
id	string	Identifier of the received payment resource.
type	string	Type of the transaction resource. The value is always `wireReceivedPayment`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer related transactions).

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all receive payment types.
status	string	The status of the Received Payment. One of `Pending`, `PendingReview`, `MarkedForReturn`, `Advanced`, `Completed` or `Returned`.
direction	string	The direction in which the funds flow (Credit only).
returnReason Optional	string	Optional. The reason if the received payment is `Returned`.
amount	integer	The amount (cents) of the wire received payment. Common to all received payment types.
description	string	Payment description (maximum of 50 characters).
counterparty	Counterparty	The party on the other end of the transaction, either the beneficiary or the originator.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction	Optional, JSON:API Relationship	The transaction of the received payment, created when the wire is processed.

Example WireReceivedPayment resource:
{
  "type": "wireReceivedPayment",
  "id": "1338",
  "attributes": {
    "createdAt": "2022-02-01T12:03:14.406Z",
    "status": "Completed",
    "amount": 100000,
    "direction": "Credit",
    "description": "Wire payment from customer",
    "counterparty": {
      "name": "John Doe",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    },
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "163555"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "129522"
      }
    },
    "receivePaymentTransaction": {
      "data": {
        "type": "transaction",
        "id": "101"
      }
    }
  }
}

Wire Payment​

Attributes​

Relationships​

Wire Transaction​

Attributes​

Relationships​

Wire Received Payment​

Attributes​

Relationships​

Wire Payment

Attributes

Relationships

Wire Transaction

Attributes

Relationships

Wire Received Payment

Attributes

Relationships