Originate a Check Deposit

curl --request POST \
  --url https://api.sandbox.solidfi.com/v2/payments/check/deposit \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "counterparty_id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
  "amount": "500.00",
  "description": "May invoice",
  "image": {
    "front": "TG9yZW0gSXBzdW0gaXMgc2ltcGx5IGR1bW15IHRleHQgb2YgdGhlIHByaW50aW5nIGFuZCB0eXBlc2V0dGluZyBpbmR1c3RyeS4gTG9yZW0gSXBzdW0gaGFzIGJlZW4gdGhlIGluZHVzdHJ5J3Mgc3RhbmRhcmQgZHVtbXkgdGV4dCBldmVyIHNpbmNlIHRoZSAxNTAwcywgd2hlbiBhbiB1bmtub3duIHByaW50ZXIgdG9vayBhIGdhbGxleSBvZiB0eXBlIGFuZCBzY3JhbWJsZWQgaXQgdG8gbWFrZSBhIHR5cGUgc3BlY2ltZW4gYm9vay4gSXQgaGFzIHN1cnZpdmVkIG5vdCBvbmx5IGZpdmUgY2VudHVyaWVzLCBidXQgYWxzbyB0aGUgbGVhcCBpbnRvIGVsZWN0cm9uaWMgdHlwZXNldHRpbmcsIHJlbWFpbmluZyBlc3NlbnRpYWxseSB1bmNoYW5nZWQuIEl0IHdhcyBwb3B1bGFyaXNlZCBpbiB0aGUgMTk2MHMgd2l0aCB0aGUgcmVsZWFzZSBvZiBMZXRyYXNldCBzaGVldHMgY29udGFpbmluZyBMb3JlbSBJcHN1bSBwYXNzYWdlcywgYW5kIG1vcmUgcmVjZW50bHkgd2l0aCBkZXNrdG9wIHB1Ymxpc2hpbmcgc29mdHdhcmUgbGlrZSBBbGR1cyBQYWdlTWFrZXIgaW5jbHVkaW5nIHZlcnNpb25zIG9mIExvcmVtIElwc3VtLg",
    "back": "TG9yZW0gSXBzdW0gaXMgc2ltcGx5IGR1bW15IHRleHQgb2YgdGhlIHByaW50aW5nIGFuZCB0eXBlc2V0dGluZyBpbmR1c3RyeS4gTG9yZW0gSXBzdW0gaGFzIGJlZW4gdGhlIGluZHVzdHJ5J3Mgc3RhbmRhcmQgZHVtbXkgdGV4dCBldmVyIHNpbmNlIHRoZSAxNTAwcywgd2hlbiBhbiB1bmtub3duIHByaW50ZXIgdG9vayBhIGdhbGxleSBvZiB0eXBlIGFuZCBzY3JhbWJsZWQgaXQgdG8gbWFrZSBhIHR5cGUgc3BlY2ltZW4gYm9vay4gSXQgaGFzIHN1cnZpdmVkIG5vdCBvbmx5IGZpdmUgY2VudHVyaWVzLCBidXQgYWxzbyB0aGUgbGVhcCBpbnRvIGVsZWN0cm9uaWMgdHlwZXNldHRpbmcsIHJlbWFpbmluZyBlc3NlbnRpYWxseSB1bmNoYW5nZWQuIEl0IHdhcyBwb3B1bGFyaXNlZCBpbiB0aGUgMTk2MHMgd2l0aCB0aGUgcmVsZWFzZSBvZiBMZXRyYXNldCBzaGVldHMgY29udGFpbmluZyBMb3JlbSBJcHN1bSBwYXNzYWdlcywgYW5kIG1vcmUgcmVjZW50bHkgd2l0aCBkZXNrdG9wIHB1Ymxpc2hpbmcgc29mdHdhcmUgbGlrZSBBbGR1cyBQYWdlTWFrZXIgaW5jbHVkaW5nIHZlcnNpb25zIG9mIExvcmVtIElwc3VtLg"
  },
  "external_reference_id": "123-9088-2"
}
'

{
  "id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "status": "originated",
  "amount": "93.50",
  "currency": "usd",
  "direction": "debit",
  "method": "ach",
  "type": "push",
  "message": "outgoing",
  "description": "Invoice payment",
  "available_balance": "500.00",
  "pending_credits": "0.00",
  "pending_debits": "93.50",
  "counterparty": {
    "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
    "name": "John Doe",
    "verification_status": "pass",
    "account_number": "98324502",
    "routing_number": "121042882",
    "account_type": "business_checking",
    "bank_name": "Wells Fargo",
    "beneficiary_bank": {
      "identifier_code": "ICICINBBNRI",
      "name": "ICICI Bank",
      "address": {
        "line1": "256 Main St",
        "line2": "Suite 201",
        "city": "Bengaluru",
        "state": "KA",
        "country": "IN",
        "postal_code": "900009"
      }
    },
    "correspondent_bank": {
      "identifier_code": "SCBLUS33XXX",
      "name": "STANDARD CHARTERED BANK",
      "address": {
        "line1": "1095 12th Ave",
        "line2": "Suite 201",
        "city": "New York",
        "state": "NY",
        "country": "US",
        "postal_code": "10001"
      }
    },
    "shipping_address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10001"
    }
  },
  "ach": {
    "effective_date": "2024-05-05",
    "company_discretionary_data": "DIRECT DEPOSIT",
    "company_entry_description": "PAYROLL",
    "trace_number": "12309876564",
    "return_code": "R01",
    "rta_id": "rta_64c6c87ee9d609f36a6f390dc378a4ce"
  },
  "domestic_wire": {
    "imad": "20240520D2B74A1C002742",
    "omad": "20240520L1B7832F000914"
  },
  "international_wire": {
    "imad": "20240520D2B74A1C002742",
    "omad": "20240520L1B7832F000914"
  },
  "rtp": {
    "reference_number": "20240410T110000Z"
  },
  "fednow": {
    "reference_number": "20240410T110000Z"
  },
  "check": {
    "check_number": "98987679",
    "cashed": "true"
  },
  "card": {
    "id": "crd_7948d9a96706dd05360a340002de725f",
    "cardholder_id": "cah_a120a61f60dfd40fdb07b2e8bcd1f6f0",
    "merchant": "Walmart",
    "auth_method": "online",
    "wallet": "google_pay",
    "rta_id": "rta_a120a61f60dfd40fdb07b2e8bcd1f6f0",
    "local_transaction": {
      "amount": "10.00",
      "currency": "usd",
      "conversion_rate": "1.00"
    },
    "available_limit": {
      "period": "daily",
      "max_spend_amount": "50.00"
    }
  },
  "external_reference_id": "123-9088-2",
  "purpose": "May Invoice",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "attachments": [
    {
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "label": "formation",
      "timestamps": {
        "created_at": "2024-04-01T21:00:00Z",
        "deleted_at": "2024-04-01T21:00:00Z"
      }
    }
  ],
  "metadata": {},
  "reconciliation": {
    "status": "reconciled",
    "master_account": [
      {
        "id": "mas_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
        "amount": "93.50"
      }
    ],
    "sub_account": [
      {
        "id": "sub_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_a0b56852400c9fede6233fd8c2e60f9c",
        "amount": "93.50"
      }
    ]
  },
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-01T21:00:00Z",
    "settled_at": "2024-04-01T21:00:00Z"
  }
}

POST

payments

check

deposit

Originate a Check Deposit

curl --request POST \
  --url https://api.sandbox.solidfi.com/v2/payments/check/deposit \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "counterparty_id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
  "amount": "500.00",
  "description": "May invoice",
  "image": {
    "front": "TG9yZW0gSXBzdW0gaXMgc2ltcGx5IGR1bW15IHRleHQgb2YgdGhlIHByaW50aW5nIGFuZCB0eXBlc2V0dGluZyBpbmR1c3RyeS4gTG9yZW0gSXBzdW0gaGFzIGJlZW4gdGhlIGluZHVzdHJ5J3Mgc3RhbmRhcmQgZHVtbXkgdGV4dCBldmVyIHNpbmNlIHRoZSAxNTAwcywgd2hlbiBhbiB1bmtub3duIHByaW50ZXIgdG9vayBhIGdhbGxleSBvZiB0eXBlIGFuZCBzY3JhbWJsZWQgaXQgdG8gbWFrZSBhIHR5cGUgc3BlY2ltZW4gYm9vay4gSXQgaGFzIHN1cnZpdmVkIG5vdCBvbmx5IGZpdmUgY2VudHVyaWVzLCBidXQgYWxzbyB0aGUgbGVhcCBpbnRvIGVsZWN0cm9uaWMgdHlwZXNldHRpbmcsIHJlbWFpbmluZyBlc3NlbnRpYWxseSB1bmNoYW5nZWQuIEl0IHdhcyBwb3B1bGFyaXNlZCBpbiB0aGUgMTk2MHMgd2l0aCB0aGUgcmVsZWFzZSBvZiBMZXRyYXNldCBzaGVldHMgY29udGFpbmluZyBMb3JlbSBJcHN1bSBwYXNzYWdlcywgYW5kIG1vcmUgcmVjZW50bHkgd2l0aCBkZXNrdG9wIHB1Ymxpc2hpbmcgc29mdHdhcmUgbGlrZSBBbGR1cyBQYWdlTWFrZXIgaW5jbHVkaW5nIHZlcnNpb25zIG9mIExvcmVtIElwc3VtLg",
    "back": "TG9yZW0gSXBzdW0gaXMgc2ltcGx5IGR1bW15IHRleHQgb2YgdGhlIHByaW50aW5nIGFuZCB0eXBlc2V0dGluZyBpbmR1c3RyeS4gTG9yZW0gSXBzdW0gaGFzIGJlZW4gdGhlIGluZHVzdHJ5J3Mgc3RhbmRhcmQgZHVtbXkgdGV4dCBldmVyIHNpbmNlIHRoZSAxNTAwcywgd2hlbiBhbiB1bmtub3duIHByaW50ZXIgdG9vayBhIGdhbGxleSBvZiB0eXBlIGFuZCBzY3JhbWJsZWQgaXQgdG8gbWFrZSBhIHR5cGUgc3BlY2ltZW4gYm9vay4gSXQgaGFzIHN1cnZpdmVkIG5vdCBvbmx5IGZpdmUgY2VudHVyaWVzLCBidXQgYWxzbyB0aGUgbGVhcCBpbnRvIGVsZWN0cm9uaWMgdHlwZXNldHRpbmcsIHJlbWFpbmluZyBlc3NlbnRpYWxseSB1bmNoYW5nZWQuIEl0IHdhcyBwb3B1bGFyaXNlZCBpbiB0aGUgMTk2MHMgd2l0aCB0aGUgcmVsZWFzZSBvZiBMZXRyYXNldCBzaGVldHMgY29udGFpbmluZyBMb3JlbSBJcHN1bSBwYXNzYWdlcywgYW5kIG1vcmUgcmVjZW50bHkgd2l0aCBkZXNrdG9wIHB1Ymxpc2hpbmcgc29mdHdhcmUgbGlrZSBBbGR1cyBQYWdlTWFrZXIgaW5jbHVkaW5nIHZlcnNpb25zIG9mIExvcmVtIElwc3VtLg"
  },
  "external_reference_id": "123-9088-2"
}
'

{
  "id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "status": "originated",
  "amount": "93.50",
  "currency": "usd",
  "direction": "debit",
  "method": "ach",
  "type": "push",
  "message": "outgoing",
  "description": "Invoice payment",
  "available_balance": "500.00",
  "pending_credits": "0.00",
  "pending_debits": "93.50",
  "counterparty": {
    "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
    "name": "John Doe",
    "verification_status": "pass",
    "account_number": "98324502",
    "routing_number": "121042882",
    "account_type": "business_checking",
    "bank_name": "Wells Fargo",
    "beneficiary_bank": {
      "identifier_code": "ICICINBBNRI",
      "name": "ICICI Bank",
      "address": {
        "line1": "256 Main St",
        "line2": "Suite 201",
        "city": "Bengaluru",
        "state": "KA",
        "country": "IN",
        "postal_code": "900009"
      }
    },
    "correspondent_bank": {
      "identifier_code": "SCBLUS33XXX",
      "name": "STANDARD CHARTERED BANK",
      "address": {
        "line1": "1095 12th Ave",
        "line2": "Suite 201",
        "city": "New York",
        "state": "NY",
        "country": "US",
        "postal_code": "10001"
      }
    },
    "shipping_address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10001"
    }
  },
  "ach": {
    "effective_date": "2024-05-05",
    "company_discretionary_data": "DIRECT DEPOSIT",
    "company_entry_description": "PAYROLL",
    "trace_number": "12309876564",
    "return_code": "R01",
    "rta_id": "rta_64c6c87ee9d609f36a6f390dc378a4ce"
  },
  "domestic_wire": {
    "imad": "20240520D2B74A1C002742",
    "omad": "20240520L1B7832F000914"
  },
  "international_wire": {
    "imad": "20240520D2B74A1C002742",
    "omad": "20240520L1B7832F000914"
  },
  "rtp": {
    "reference_number": "20240410T110000Z"
  },
  "fednow": {
    "reference_number": "20240410T110000Z"
  },
  "check": {
    "check_number": "98987679",
    "cashed": "true"
  },
  "card": {
    "id": "crd_7948d9a96706dd05360a340002de725f",
    "cardholder_id": "cah_a120a61f60dfd40fdb07b2e8bcd1f6f0",
    "merchant": "Walmart",
    "auth_method": "online",
    "wallet": "google_pay",
    "rta_id": "rta_a120a61f60dfd40fdb07b2e8bcd1f6f0",
    "local_transaction": {
      "amount": "10.00",
      "currency": "usd",
      "conversion_rate": "1.00"
    },
    "available_limit": {
      "period": "daily",
      "max_spend_amount": "50.00"
    }
  },
  "external_reference_id": "123-9088-2",
  "purpose": "May Invoice",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "attachments": [
    {
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "label": "formation",
      "timestamps": {
        "created_at": "2024-04-01T21:00:00Z",
        "deleted_at": "2024-04-01T21:00:00Z"
      }
    }
  ],
  "metadata": {},
  "reconciliation": {
    "status": "reconciled",
    "master_account": [
      {
        "id": "mas_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
        "amount": "93.50"
      }
    ],
    "sub_account": [
      {
        "id": "sub_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_a0b56852400c9fede6233fd8c2e60f9c",
        "amount": "93.50"
      }
    ]
  },
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-01T21:00:00Z",
    "settled_at": "2024-04-01T21:00:00Z"
  }
}

Headers

api-key

string

required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Example:

"{{api_key}}"

Body

application/json

sub_account_id

string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

counterparty_id

string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

amount

string

amount of the transaction

Example:

"500.00"

description

string

description of the transaction

Example:

"May invoice"

image

object

Show child attributes

image.front

string

front image encoded in Base64 format

Example:

"TG9yZW0gSXBzdW0gaXMgc2ltcGx5IGR1bW15IHRleHQgb2YgdGhlIHByaW50aW5nIGFuZCB0eXBlc2V0dGluZyBpbmR1c3RyeS4gTG9yZW0gSXBzdW0gaGFzIGJlZW4gdGhlIGluZHVzdHJ5J3Mgc3RhbmRhcmQgZHVtbXkgdGV4dCBldmVyIHNpbmNlIHRoZSAxNTAwcywgd2hlbiBhbiB1bmtub3duIHByaW50ZXIgdG9vayBhIGdhbGxleSBvZiB0eXBlIGFuZCBzY3JhbWJsZWQgaXQgdG8gbWFrZSBhIHR5cGUgc3BlY2ltZW4gYm9vay4gSXQgaGFzIHN1cnZpdmVkIG5vdCBvbmx5IGZpdmUgY2VudHVyaWVzLCBidXQgYWxzbyB0aGUgbGVhcCBpbnRvIGVsZWN0cm9uaWMgdHlwZXNldHRpbmcsIHJlbWFpbmluZyBlc3NlbnRpYWxseSB1bmNoYW5nZWQuIEl0IHdhcyBwb3B1bGFyaXNlZCBpbiB0aGUgMTk2MHMgd2l0aCB0aGUgcmVsZWFzZSBvZiBMZXRyYXNldCBzaGVldHMgY29udGFpbmluZyBMb3JlbSBJcHN1bSBwYXNzYWdlcywgYW5kIG1vcmUgcmVjZW50bHkgd2l0aCBkZXNrdG9wIHB1Ymxpc2hpbmcgc29mdHdhcmUgbGlrZSBBbGR1cyBQYWdlTWFrZXIgaW5jbHVkaW5nIHZlcnNpb25zIG9mIExvcmVtIElwc3VtLg"

image.back

string

back image encoded in Base64 format

Example:

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"123-9088-2"

Response

Originate a Check Deposit

string

unique id of the transaction

Example:

"txn_817d2a074042bb4ec54e08fd82b1e0a8"

sub_account_id

string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

master_account_id

string

unique id of the master account holder

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

status

enum<string>

status of the transaction

Available options:

originated,

pending,

clearing,

cleared,

settled,

canceled,

in_review,

returned,

reversed,

received,

declined,

refunded

Example:

"originated"

amount

string

amount of the transaction

Example:

"93.50"

currency

enum<string>

currency of the transaction

Available options:

usd

Example:

"usd"

direction

enum<string>

if transaction is debit or credit

Available options:

debit,

credit

Example:

"debit"

method

enum<string>

payment method for the transaction

Available options:

ach,

domestic_wire,

international_wire,

check,

fednow,

rtp,

debit_card,

card_issuing

Example:

"ach"

type

enum<string>

type within the payment method used for the transaction

Available options:

push,

pull,

decline,

cancel,

return,

send,

deposit,

request,

auth,

adjust,

reverse,

refund

Example:

"push"

message

enum<string>

if transaction is incoming or outgoing

Available options:

incoming,

outgoing

Example:

"outgoing"

description

string

description of the transaction

Example:

"Invoice payment"

available_balance

string

available balance in the sub account after the transaction

Example:

"500.00"

pending_credits

string

total pending credits to the sub account after the transaction

Example:

"0.00"

pending_debits

string

total pending debits to the sub account after the transaction

Example:

"93.50"

counterparty

object

Show child attributes

counterparty.id

string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

counterparty.name

string

name of the counterparty

Example:

"John Doe"

counterparty.verification_status

enum<string>

account verification status of the counterparty

Available options:

pass,

fail,

review

Example:

"pass"

counterparty.account_number

string

bank account number of the counterparty

Example:

"98324502"

counterparty.routing_number

string

routing number of the counterparty's bank

Example:

"121042882"

counterparty.account_type

enum<string>

type of counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

Example:

"business_checking"

counterparty.bank_name

string

name of counterparty's bank

Example:

"Wells Fargo"

counterparty.beneficiary_bank

object

Show child attributes

counterparty.beneficiary_bank.identifier_code

string

SWIFT/BIC code of counterparty's bank

Example:

"ICICINBBNRI"

counterparty.beneficiary_bank.name

string

name of counterparty's bank

Example:

"ICICI Bank"

counterparty.beneficiary_bank.address

object

Show child attributes

counterparty.beneficiary_bank.address.line1

string

line 1 of the address

Example:

"256 Main St"

counterparty.beneficiary_bank.address.line2

string

line 2 of the address

Example:

"Suite 201"

counterparty.beneficiary_bank.address.city

string

city of the address

Example:

"Bengaluru"

counterparty.beneficiary_bank.address.state

string

2-Letter state abbreviation (ex: CA)

Example:

"KA"

counterparty.beneficiary_bank.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"IN"

counterparty.beneficiary_bank.address.postal_code

string

postal code

Example:

"900009"

counterparty.correspondent_bank

object

Show child attributes

counterparty.correspondent_bank.identifier_code

string

SWIFT/BIC code of counterparty's correspondent bank

Example:

"SCBLUS33XXX"

counterparty.correspondent_bank.name

string

name of counterparty's correspondent bank

Example:

"STANDARD CHARTERED BANK"

counterparty.correspondent_bank.address

object

Show child attributes

counterparty.correspondent_bank.address.line1

string

line 1 of the address

Example:

"1095 12th Ave"

counterparty.correspondent_bank.address.line2

string

line 2 of the address

Example:

"Suite 201"

counterparty.correspondent_bank.address.city

string

city of the address

Example:

"New York"

counterparty.correspondent_bank.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

counterparty.correspondent_bank.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

counterparty.correspondent_bank.address.postal_code

string

postal code

Example:

"10001"

counterparty.shipping_address

object

Show child attributes

counterparty.shipping_address.line1

string

line 1 of the address

Example:

"123 Main St"

counterparty.shipping_address.line2

string

line 2 of the address

Example:

""

counterparty.shipping_address.city

string

city of the address

Example:

"New York"

counterparty.shipping_address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

counterparty.shipping_address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

counterparty.shipping_address.postal_code

string

postal code

Example:

"10001"

ach

object

Show child attributes

ach.effective_date

string

date on which the ACH must post on the beneficiary's bank account

Example:

"2024-05-05"

ach.company_discretionary_data

string

text field within the ACH batch file used to reference ACH originator details like name, etc.

Example:

"DIRECT DEPOSIT"

ach.company_entry_description

string

text field within the ACH batch file that describes the purpose of the ACH transaction

Example:

"PAYROLL"

ach.trace_number

string

unique identifier within the ACH batch file

Example:

"12309876564"

ach.return_code

string

reason code given in case of ACH return

Example:

"R01"

ach.rta_id

string

unique id for real time authorization

Example:

"rta_64c6c87ee9d609f36a6f390dc378a4ce"

domestic_wire

object

Show child attributes

domestic_wire.imad

string

IMAD (Input Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.

Example:

"20240520D2B74A1C002742"

domestic_wire.omad

string

OMAD (Output Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.

Example:

"20240520L1B7832F000914"

international_wire

object

Show child attributes

international_wire.imad

string

IMAD (Input Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.

Example:

"20240520D2B74A1C002742"

international_wire.omad

string

OMAD (Output Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.

Example:

"20240520L1B7832F000914"

rtp

object

Show child attributes

rtp.reference_number

string

reference number of the RTP transaction that shown to the beneficiary

Example:

"20240410T110000Z"

fednow

object

Show child attributes

fednow.reference_number

string

reference number of the FedNow transaction that shown to the beneficiary

Example:

"20240410T110000Z"

check

object

Show child attributes

check.check_number

string

check number

Example:

"98987679"

check.cashed

string

if the check is cashed or not

Example:

"true"

card

object

Show child attributes

card.id

string

unique id of the card

Example:

"crd_7948d9a96706dd05360a340002de725f"

card.cardholder_id

string

unique id of the card holder

Example:

"cah_a120a61f60dfd40fdb07b2e8bcd1f6f0"

card.merchant

string

merchant the card was used at

Example:

"Walmart"

card.auth_method

string

method of use for the card transaction

Example:

"online"

card.wallet

string

digital wallet type

Example:

"google_pay"

card.rta_id

string

unique id for real time authorization

Example:

"rta_a120a61f60dfd40fdb07b2e8bcd1f6f0"

card.local_transaction

object

Show child attributes

card.local_transaction.amount

string

transaction amount in local currency

Example:

"10.00"

card.local_transaction.currency

string

local currency code

Example:

"usd"

card.local_transaction.conversion_rate

string

currency conversion rate

Example:

"1.00"

card.available_limit

object

Show child attributes

card.available_limit.period

enum<string>

time period available in which the maximum amount is allowed to be spent

Available options:

daily,

per_transaction,

weekly,

monthly,

yearly,

all_time

Example:

"daily"

card.available_limit.max_spend_amount

string

maximum amount available to be spent in the set period

Example:

"50.00"

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"123-9088-2"

purpose

string

purpose of the transaction

Example:

"May Invoice"

ofac

object

Show child attributes

ofac.status

enum<string>

ofac status of the counterparty

Available options:

pass,

fail

Example:

"pass"

ofac.last_updated_at

string

last date and time at which the counterparty's ofac status was checked

Example:

"2024-04-01T21:00:00Z"

attachments

object[]

Show child attributes

attachments.id

string

unique id of the attachment created

Example:

"att_a8d2b191fa0e960d8e49a4bfd320e07b"

attachments.label

string

label of the attachment

Example:

"formation"

attachments.timestamps

object

Show child attributes

attachments.timestamps.created_at

string

date and time at which the attachment was created

Example:

"2024-04-01T21:00:00Z"

attachments.timestamps.deleted_at

string

date and time at which the attachment was deleted

Example:

"2024-04-01T21:00:00Z"

metadata

object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

reconciliation

object

Show child attributes

reconciliation.status

enum<string>

reconciliation status of the transaction

Available options:

reconciled,

not_reconciled

Example:

"reconciled"

reconciliation.master_account

object[]

Show child attributes

reconciliation.master_account.id

string

unique id of the master account

Example:

"mas_bda1e562657c41e553104b10aad3fe70"

reconciliation.master_account.transaction_id

string

unique id of the master account transaction

Example:

"txn_817d2a074042bb4ec54e08fd82b1e0a8"

reconciliation.master_account.amount

string

master account transaction amount

Example:

"93.50"

reconciliation.sub_account

object[]

Show child attributes

reconciliation.sub_account.id

string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

reconciliation.sub_account.transaction_id

string

unique id of the sub account transaction

Example:

"txn_a0b56852400c9fede6233fd8c2e60f9c"

reconciliation.sub_account.amount

string

sub account transaction amount

Example:

"93.50"

timestamps

object

Show child attributes

timestamps.created_at

string

date and time at which the transaction was created

Example:

"2024-04-01T21:00:00Z"

timestamps.updated_at

string

date and time at which the transaction was updated

Example:

"2024-04-01T21:00:00Z"

timestamps.settled_at

string

date and time at which the transaction was settled

Example:

"2024-04-01T21:00:00Z"

Originate a Check Send Retrieve a Transaction

⌘I

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Originate a Check Deposit

Headers

Body

Response