API Reference
Send Bank Information
API Reference
- POSTGet Client Token
- GETGet Trades
- POSTCreate Trade
- GETGet Quote
- POSTSend Identity information
- POSTAccept Identity documents
- GETGet Supported Tokens
- GETGet Enabled Tokens
- GETGet Payment Method information
- GETGet Order(s)
- GETGet Bank Account
- GETFetch KYC
- GETGet Customers
- POSTPost Customer Information
- POSTSend Bank Information
- GETGet Geocoverage
- GETGet Fiat Currencies
API Reference
Send Bank Information
Simply populate the appropriate field in the plaidData object. Make sure to fill in the correct field corresponding to the correct Plaid API endpoint. For example, if you call the Plaid transactions API, you should set plaidData.transactionsResponse to be the JSON string containing the response. Note that the response fields in plaidData are all optional and you may populate as many or few as you would like, as long as an authResponse is sent at least once per account.
Important note: You must provide an authResponse at least once per customer bank account so that we can store the mapping from bank account to Plaid account ID.
POST
/
bank
/
transactions
curl --request POST \
--url https://api.sandbox.sardine.ai/v1/bank/transactions \
--header 'Authorization: Basic <encoded-value>'{
"sessionKey": "<string>",
"customerId": "<string>",
"plaidData": {
"transactionsResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"transactions": [
{
"account_id": "<string>",
"amount": 123,
"iso_currency_code": "<string>",
"unofficial_currency_code": null,
"category": [
{}
],
"category_id": "<string>",
"check_number": null,
"date": "<string>",
"datetime": null,
"authorized_date": "<string>",
"authorized_datetime": null,
"location": {
"address": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"lat": 123,
"lon": 123,
"store_number": "<string>"
},
"name": "<string>",
"merchant_name": "<string>",
"payment_meta": {
"by_order_of": null,
"payee": null,
"payer": null,
"payment_method": null,
"payment_processor": null,
"ppd_id": null,
"reason": null,
"reference_number": null
},
"payment_channel": "<string>",
"pending": true,
"pending_transaction_id": null,
"account_owner": null,
"transaction_id": "<string>",
"transaction_code": null,
"transaction_type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"total_transactions": 123,
"request_id": "<string>"
},
"authResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"limit": null,
"iso_currency_code": "<string>",
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"numbers": {
"ach": [
{
"account": "<string>",
"account_id": "<string>",
"routing": "<string>",
"wire_routing": "<string>"
}
],
"eft": [
{
"account": "<string>",
"account_id": "<string>",
"institution": "<string>",
"branch": "<string>"
}
],
"international": [
{
"account_id": "<string>",
"bic": "<string>",
"iban": "<string>"
}
],
"bacs": [
{
"account": "<string>",
"account_id": "<string>",
"sort_code": "<string>"
}
]
},
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"balanceResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>"
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"institution_id": "<string>",
"item_id": "<string>",
"products": [
{}
],
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"identityResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"owners": [
{
"addresses": [
{
"data": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street": "<string>"
},
"primary": true
}
],
"emails": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
],
"names": [
{}
],
"phone_numbers": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
]
}
],
"subtype": "<string>",
"type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"assetsReportResponse": {
"report": {
"asset_report_id": "<string>",
"client_report_id": "<string>",
"date_generated": "<string>",
"days_requested": 123,
"items": [
{
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"days_available": 123,
"historical_balances": [
{
"current": 123,
"date": "<string>",
"iso_currency_code": "<string>",
"unofficial_currency_code": null
}
],
"mask": "<string>",
"name": "<string>",
"official_name": null,
"owners": [
{
"addresses": [
{
"data": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street": "<string>"
},
"primary": true
}
],
"emails": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
],
"names": [
"<string>"
],
"phone_numbers": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
]
}
],
"ownership_type": null,
"subtype": "<string>",
"transactions": [
{}
],
"type": "<string>"
}
],
"date_last_updated": "<string>",
"institution_id": "<string>",
"institution_name": "<string>",
"item_id": "<string>"
}
],
"user": {
"client_user_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"phone_number": "<string>",
"ssn": "<string>"
}
},
"request_id": "<string>",
"warnings": [
{}
]
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
200 - application/json
OK
curl --request POST \
--url https://api.sandbox.sardine.ai/v1/bank/transactions \
--header 'Authorization: Basic <encoded-value>'{
"sessionKey": "<string>",
"customerId": "<string>",
"plaidData": {
"transactionsResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"transactions": [
{
"account_id": "<string>",
"amount": 123,
"iso_currency_code": "<string>",
"unofficial_currency_code": null,
"category": [
{}
],
"category_id": "<string>",
"check_number": null,
"date": "<string>",
"datetime": null,
"authorized_date": "<string>",
"authorized_datetime": null,
"location": {
"address": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"lat": 123,
"lon": 123,
"store_number": "<string>"
},
"name": "<string>",
"merchant_name": "<string>",
"payment_meta": {
"by_order_of": null,
"payee": null,
"payer": null,
"payment_method": null,
"payment_processor": null,
"ppd_id": null,
"reason": null,
"reference_number": null
},
"payment_channel": "<string>",
"pending": true,
"pending_transaction_id": null,
"account_owner": null,
"transaction_id": "<string>",
"transaction_code": null,
"transaction_type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"total_transactions": 123,
"request_id": "<string>"
},
"authResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"limit": null,
"iso_currency_code": "<string>",
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"numbers": {
"ach": [
{
"account": "<string>",
"account_id": "<string>",
"routing": "<string>",
"wire_routing": "<string>"
}
],
"eft": [
{
"account": "<string>",
"account_id": "<string>",
"institution": "<string>",
"branch": "<string>"
}
],
"international": [
{
"account_id": "<string>",
"bic": "<string>",
"iban": "<string>"
}
],
"bacs": [
{
"account": "<string>",
"account_id": "<string>",
"sort_code": "<string>"
}
]
},
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"balanceResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>"
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"subtype": "<string>",
"type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"institution_id": "<string>",
"item_id": "<string>",
"products": [
{}
],
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"identityResponse": {
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"mask": "<string>",
"name": "<string>",
"official_name": "<string>",
"owners": [
{
"addresses": [
{
"data": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street": "<string>"
},
"primary": true
}
],
"emails": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
],
"names": [
{}
],
"phone_numbers": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
]
}
],
"subtype": "<string>",
"type": "<string>"
}
],
"item": {
"available_products": [
{}
],
"billed_products": [
{}
],
"consent_expiration_time": null,
"error": null,
"institution_id": "<string>",
"item_id": "<string>",
"update_type": "<string>",
"webhook": "<string>"
},
"request_id": "<string>"
},
"assetsReportResponse": {
"report": {
"asset_report_id": "<string>",
"client_report_id": "<string>",
"date_generated": "<string>",
"days_requested": 123,
"items": [
{
"accounts": [
{
"account_id": "<string>",
"balances": {
"available": 123,
"current": 123,
"iso_currency_code": "<string>",
"limit": null,
"unofficial_currency_code": null
},
"days_available": 123,
"historical_balances": [
{
"current": 123,
"date": "<string>",
"iso_currency_code": "<string>",
"unofficial_currency_code": null
}
],
"mask": "<string>",
"name": "<string>",
"official_name": null,
"owners": [
{
"addresses": [
{
"data": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street": "<string>"
},
"primary": true
}
],
"emails": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
],
"names": [
"<string>"
],
"phone_numbers": [
{
"data": "<string>",
"primary": true,
"type": "<string>"
}
]
}
],
"ownership_type": null,
"subtype": "<string>",
"transactions": [
{}
],
"type": "<string>"
}
],
"date_last_updated": "<string>",
"institution_id": "<string>",
"institution_name": "<string>",
"item_id": "<string>"
}
],
"user": {
"client_user_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"phone_number": "<string>",
"ssn": "<string>"
}
},
"request_id": "<string>",
"warnings": [
{}
]
}
}
}