Send an Check

Send an Check

POST /v1/send/check

Send an Check

cURL

curl --request POST \
  --url https://qa-api.sbx.solidfi.com/v1/send/check \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "{{accountId}}",
  "amount": "10.00",
  "contactId": "{{contactId}}",
  "description": "Payment",
  "type": "physical"
}
'

201

{
  "accountId": "acc-ab566541-69c5-4393-8a41-47f167b2af02",
  "accountNumber": "",
  "accountType": "",
  "address": {
    "addressType": "check",
    "city": "New York",
    "country": "US",
    "line1": "123 Main St",
    "line2": "",
    "postalCode": "10001",
    "state": "NY"
  },
  "amount": "10.00",
  "attachment": "",
  "bankName": "",
  "bin": "",
  "card": null,
  "contactId": "con-fe4769ef-e6c1-4f9d-8bbd-fe0ac57243f7",
  "createdAt": "2023-11-20T08:22:13Z",
  "description": "Payment",
  "destinationAmount": "0.00",
  "destinationCurrency": "",
  "fallbackTransferId": "",
  "iban": "",
  "id": "tra-4b0b21c2-bbea-48cf-a46f-bad6d00c42a8",
  "metadata": null,
  "modifiedAt": "2023-11-20T08:22:13Z",
  "name": "Bright Might LLC",
  "parentTransferId": "",
  "purposeCode": "",
  "reviewCode": "",
  "reviewMessage": "",
  "routingNumber": "",
  "status": "completed",
  "title": "",
  "transferSubType": "originated",
  "transferType": "physicalCheck",
  "transferredAt": "2023-11-20T08:22:13Z",
  "txnType": "debit",
  "type": "",
  "valid": ""
}

Headers

sd-api-key · string

Example:

"{{sd-api-key}}"

sd-person-id · string

Example:

"{{sd-person-id}}"

Body

application/json

accountId · string

Example:

"{{accountId}}"

amount · string

Example:

"10.00"

contactId · string

Example:

"{{contactId}}"

description · string

Example:

"Payment"

type · string

Example:

"physical"

Response

201 - application/json

Send a Check

accountId · string

Example:

"acc-ab566541-69c5-4393-8a41-47f167b2af02"

accountNumber · string

Example:

""

accountType · string

Example:

""

address · object

Show child attributes

amount · string

Example:

"10.00"

attachment · string

Example:

""

bankName · string

Example:

""

bin · string

Example:

""

card · unknown

contactId · string

Example:

"con-fe4769ef-e6c1-4f9d-8bbd-fe0ac57243f7"

createdAt · string

Example:

"2023-11-20T08:22:13Z"

description · string

Example:

"Payment"

destinationAmount · string

Example:

"0.00"

destinationCurrency · string

Example:

""

fallbackTransferId · string

Example:

""

iban · string

Example:

""

id · string

Example:

"tra-4b0b21c2-bbea-48cf-a46f-bad6d00c42a8"

metadata · unknown

modifiedAt · string

Example:

"2023-11-20T08:22:13Z"

name · string

Example:

"Bright Might LLC"

parentTransferId · string

Example:

""

purposeCode · string

Example:

""

reviewCode · string

Example:

""

reviewMessage · string

Example:

""

routingNumber · string

Example:

""

status · string

Example:

"completed"

title · string

Example:

""

transferSubType · string

Example:

"originated"

transferType · string

Example:

"physicalCheck"

transferredAt · string

Example:

"2023-11-20T08:22:13Z"

txnType · string

Example:

"debit"

type · string

Example:

""

valid · string

Example:

""