settlement_generated

Last updated: November 20, 2024


1{
2  "id": "evt_piw73n7vcs5ubd7l2xu74syac4",
3  "type": "settlement_generated",
4  "version": "1.0.4",
5  "created_on": "2024-11-04T14:10:26.8373019Z",
6  "data": {
7    "account": {
8      "client_id": "cli_chxj47nausgebpqqhd6syuwaoa",
9      "entity_id": "ent_yirkfx5lpxwzyyovxj3bdhfxxe",
10      "entity_name": "The Online Retailer UK",
11      "entity_cko_legal_entity_code": "cko-ltd-uk",
12      "source_id": "ca_aqiswowvowuevmpmypg4a3td6a"
13    },
14    "settlement_details": {
15      "payout_id": "pay_n7shh3ndlazfrl4lc6vdj27xtm",
16      "source_currency": "GBP",
17      "source_amount": 1019.12,
18      "balance_as_of": "2024-11-04T00:00:00+00:00",
19      "bank_name": "Test Bank",
20      "payment_instrument_id": "src_tpbzvjf3qyhu3lnjttsrw4qvwy",
21      "billing_descriptor": "000000012KPB"
22    },
23    "event_type": "SettlementGenerated",
24    "version": "1.0.4"
25  },
26  "_links": {
27    "self": {
28      "href": "https://api.checkout.com/workflows/events/evt_piw73n7vcs5ubd7l2xu74syac4"
29    }
30  }
31}

Field name	Description
`client_id` string	The unique identifier of the client.
`entity_id` string	The unique identifier of the associated entity.
`entity_name` string	The name of the associated entity.
`entity_cko_legal_entity_code` string	The Checkout.com legal entity that you're contracted with.
`source_id` string	The unique identifier of the currency account.
`payout_id` string	The unique identifier of the settlement payout.
`source_currency` string	The currency from the source account, in ISO-4217 format.
`source_amount` number	The Available balance in the corresponding currency account, which is settled to you.
`balance_as_of` string	The date and time when the Available balance was checked for settlement, in ISO-8601 format.
`bank_name` string	The name of your bank that the settlement is paid out to.
`payment_instrument_id` string	The unique identifier of the payment instrument.
`billing_descriptor` string	The identifier in your bank statement for this settlement transaction. Checkout.com sends the settlement ID as the billing descriptor.

settlement_generated

Example: Settlement generated

Webhook response fields