Originate a Check Deposit

POST

payments

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",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "status": "originated",
  "amount": "500.00",
  "currency": "usd",
  "direction": "credit",
  "method": "check",
  "type": "deposit",
  "message": "outgoing",
  "description": "May invoice",
  "available_balance": "9200.00",
  "pending_credits": "500.00",
  "pending_debits": "0.00",
  "counterparty": {
    "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
    "name": "John Doe",
    "verification_status": "pass",
    "account_number": "",
    "routing_number": "",
    "account_type": "",
    "bank_name": "",
    "beneficiary_bank": null,
    "correspondent_bank": null,
    "shipping_address": null
  },
  "check": {
    "check_number": "98987679",
    "cashed": true,
    "shipping_address": null,
    "tracking": null
  },
  "parent_transaction_id": "",
  "external_reference_id": "123-9088-2",
  "purpose": "",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "attachments": null,
  "metadata": null,
  "reconciliation": {
    "status": "not_reconciled",
    "master_account": null,
    "sub_account": [
      {
        "id": "sub_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
        "amount": "500.00"
      }
    ]
  },
  "timestamps": {
    "created_at": "2024-04-04T11:06:00Z",
    "updated_at": "2024-04-04T11:06:00Z",
    "settled_at": "2024-04-04T11:06: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.

Body

application/json

sub_account_id

string

unique id of the sub account

counterparty_id

string

unique id of the counterparty

amount

string

amount of the transaction

description

string

description of the transaction

image

object

external_reference_id

string

unique id to cross-reference records with external systems

Response

201

application/json

Originate a Check Deposit

string

unique id of the transaction

sub_account_id

string

unique id of the sub account

master_account_id

string

unique id of the master account holder

status

enum<string>

status of the transaction

Available options:

originated,

pending,

clearing,

cleared,

settled,

canceled,

in_review,

returned,

reversed,

received,

declined,

refunded

amount

string

amount of the transaction

currency

enum<string>

currency of the transaction

Available options:

usd

direction

enum<string>

if transaction is debit or credit

Available options:

debit,

credit

method

enum<string>

payment method for the transaction

Available options:

ach,

domestic_wire,

international_wire,

check,

fednow,

rtp,

debit_card,

card_issuing

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

message

enum<string>

if transaction is incoming or outgoing

Available options:

incoming,

outgoing

description

string

description of the transaction

available_balance

string

available balance in the sub account after the transaction

pending_credits

string

total pending credits to the sub account after the transaction

pending_debits

string

total pending debits to the sub account after the transaction

counterparty

object

counterparty.id

string

unique id of the counterparty

counterparty.name

string

name of the counterparty

counterparty.verification_status

enum<string>

account verification status of the counterparty

Available options:

pass,

fail,

review

counterparty.account_number

string

bank account number of the counterparty

counterparty.routing_number

string

routing number of the counterparty's bank

counterparty.account_type

enum<string>

type of counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

counterparty.bank_name

string

name of counterparty's bank

counterparty.beneficiary_bank

object

counterparty.correspondent_bank

object

counterparty.shipping_address

object

ach

object

domestic_wire

object

international_wire

object

rtp

object

fednow

object

check

object

card

object

external_reference_id

string

unique id to cross-reference records with external systems

purpose

string

purpose of the transaction

ofac

object

attachments

object[]

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

timestamps

object

Originate a Check Send Retrieve a Transaction

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",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "status": "originated",
  "amount": "500.00",
  "currency": "usd",
  "direction": "credit",
  "method": "check",
  "type": "deposit",
  "message": "outgoing",
  "description": "May invoice",
  "available_balance": "9200.00",
  "pending_credits": "500.00",
  "pending_debits": "0.00",
  "counterparty": {
    "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
    "name": "John Doe",
    "verification_status": "pass",
    "account_number": "",
    "routing_number": "",
    "account_type": "",
    "bank_name": "",
    "beneficiary_bank": null,
    "correspondent_bank": null,
    "shipping_address": null
  },
  "check": {
    "check_number": "98987679",
    "cashed": true,
    "shipping_address": null,
    "tracking": null
  },
  "parent_transaction_id": "",
  "external_reference_id": "123-9088-2",
  "purpose": "",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "attachments": null,
  "metadata": null,
  "reconciliation": {
    "status": "not_reconciled",
    "master_account": null,
    "sub_account": [
      {
        "id": "sub_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
        "amount": "500.00"
      }
    ]
  },
  "timestamps": {
    "created_at": "2024-04-04T11:06:00Z",
    "updated_at": "2024-04-04T11:06:00Z",
    "settled_at": "2024-04-04T11:06:00Z"
  }
}

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Originate a Check Deposit

Headers

Body

Response