A Settlement is defined and managed under an organization and is identified in the system by its unique ID, the UUID.
The following table describes the fields in the REST API messages for settlements:
| Field | Type | Description |
|---|---|---|
| id | string | The UUID. A unique ID of the settlement. |
| created_at | date | The creation time of the settlement. Standard format of timestamp with a time zone. ISO_8601 |
| updated_at | date | The time when the settlement details were last updated. Standard format of timestamp with a time zone. ISO_8601 |
| status | string | The status of the Settlement. One of the following: * SUCCESS * PENDING * FAILED * CANCELLED * EXPIRED * REJECTED |
| amount | number | The amount that is requested for settlement. |
| settled_amount | number | The amount settled with the crypto symbol. |
| currency | string | The currency of the settlement. |
| symbol | string | The crypto symbol of the settlement. |
| exchange_rate | boolean | The exchange rate is being updated after the settled amount. |
| description | string | The settlement description. |
| payment_method | string | The payment method used for the settlement. |
| metadata | object | The metadata of the settlement is relevant for CRYPTO settlements. |
| wallet_id | object | The wallet id this settlement belongs to. See Wallet Object |
| organization_id | string | The organization id this settlement belongs to. See Organization Object |