Retrieve Settlement

Returns a detailed breakdown of an outbound settlement by account and customer. Filterable by source and destination accounts.

SecurityOAuth2: OAuth2Flow

Request

path Parameters

required

string

Settlement ID

query Parameters

source_account_id	string Source Account ID to filter settlement on
destination_account_id	string Destination Account ID to filter settlement on

header Parameters

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

Callbacks

postTest Summary

get/v1/settlements/{id}

Response samples

application/json

{"data": {"id": "string",
"settlement_status": "INITIALIZED",
"settlement_executed_timestamp": "2019-08-24T14:15:22Z",
"settlement_asset_type": "FIAT",
"settlement_currency": "string",
"settlement_amount": 0,
"settlement_details": [{"source_account_customer_id": "string",
"source_account_id": "string",
"source_asset_type": "FIAT",
"source_currency": "string",
"source_amount": 0,
"destination_account_customer_id": "string",
"destination_account_id": "string",
"destination_asset_type": "FIAT",
"destination_currency": "string",
"destination_amount": 0,
"payment_payor_id": "string",
"payment_reference_id": "string",
"payment_expected_amount": "string"
}
]
}
}

Callback payload samples

POST: Test Summary

application/json

{"id": "string",
"customer_type": "INDIVIDUAL",
"status": "ACTIVE",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"mailing_address": {"unit_number": "string",
"address_line1": "string",
"address_line2": "string",
"address_line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"telephone_number": "string",
"tax_reference_number": "string",
"passport_number": "string",
"nationality": "string",
"date_of_birth": "2019-08-24",
"us_residency_status": "US_CITIZEN",
"employment_status": "EMPLOYEE",
"employment_description": "string",
"employer_name": "string",
"occupation": "string",
"investment_profile": {"primary_source_of_funds": "EMPLOYMENT",
"primary_source_of_funds_description": "string",
"total_assets": "UPTO_10K",
"usd_value_of_fiat": "UPTO_10K",
"monthly_deposits": "UPTO_5",
"monthly_withdrawals": "UPTO_5",
"monthly_investment_deposit": "UPTO_1K",
"monthly_investment_withdrawal": "UPTO_1K",
"usd_value_of_crypto": "UPTO_10K",
"monthly_crypto_deposits": "UPTO_5",
"monthly_crypto_withdrawals": "UPTO_5",
"monthly_crypto_investment_deposit": "UPTO_1K",
"monthly_crypto_investment_withdrawal": "UPTO_1K"
},
"kyc_profile": {"funds_send_receive_jurisdictions": ["string"
],
"engage_in_activities": ["NONE"
]
}
}