Resources

Wire Drawdown

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

id

string

Identifier of the wire drawdown resource.

type

string

Type of the resource, the value is always wire-drawdown.

attributes

JSON Object

JSON object representing the wire drawdown data.

relationships

JSON:API Relationships

Describes relationships between the wire-drawdown resource and other resources.

Attributes

createdAt

RFC3339 Date string

The date the resource was created.

amount

integer

The amount (cents) of the wire drawdown.

description

string

Wire drawdown description.

counterparty

Wire Counterparty

The beneficiary party on the other end of the wire drawdown.

direction

string

The direction of the wire drawdown, either Incoming or Outgoing.

imad

string

Input Message Accountability Data. It's a unique number given to each wire drawdown.

omad

string

Output Message Accountability Data. It's a unique number given to each wire drawdown.

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.

originatorToBeneficiaryInformation

string

Originator To Beneficiary Information, multi-line string delimited by \n.

Relationships

account

JSON:API Relationship

The Account the wire drawdown belongs to.

customer

JSON:API Relationship

The Customer the wire drawdown belongs to.

drawdownPayment

JSON:API Relationship

The Wire Payment created as a result of sending the drawdown payment.

Example WireDrawdown Resource:

{
  "type": "wireDrawdown",
  "id": "10000",
  "attributes": {
    "createdAt": "2024-10-29T21:35:58.898Z",
    "amount": 97,
    "direction": "Incoming",
    "counterparty": {
      "name": "LAB LLC",
      "routingNumber": "021000021",
      "accountNumber": "1000000000"
    },
    "imad": "20241029MMAAAAAA033351",
    "omad": "20241029MMBBBBBB00041910291735FT03",
    "description": "Hello World",
    "senderReference": "54465316546"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10000"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    }
  }
}