SettlementTransferEventData | ePay documentation

Payload delivered for settlement.transfer-ready.v1 webhooks.

Settlement transfers models the actual bank payouts from the acquirer to your bank.

idstring

The ePay ID of the settlement transfer

Format:

uuid

Example:

"019b3130-5d58-716d-8881-9a3ec506017f"

acquirerstring

Acquirer identifier

Example:

"shift4"

settlementNamestring

Name or filename of the settlement report as received by ePay. This is mainly used for logging and debugging purposes.

Example:

"settlement.csv"

List of MIDs included in the settlement report.

postingDatestring

The posting date of the transfer as registered by the acquirer

Format:

date

Example:

"2025-01-01"

netAmountstring

Net amount (After adjustments and fees) as numeric string

Example:

"99.01"

currencystring

ISO 4217 currency

Example:

"DKK"

acquirerReferencestring

Reference from acquirer

Example:

"acq-123"

The sum of all adjustments from associated SettlementTransactions

createdAtstring

Format:

date-time

Example:

"2025-12-18T11:20:11Z"

SettlementTransferEventData

{  "settlementTransfer": {    "id": "019b3130-5d58-716d-8881-9a3ec506017f",    "acquirer": "shift4",    "settlementName": "settlement.csv",    "settlementIds": [      [        "R01234"      ]    ],    "postingDate": "2025-01-01",    "netAmount": "99.01",    "currency": "DKK",    "acquirerReference": "acq-123",    "adjustments": [      {        "type": "FEE",        "amount": "-1.00",        "description": "discount_rate"      }    ],    "adjustmentSums": [      {        "type": "FEE",        "amount": "-1.00",        "description": "discount_rate"      }    ],    "createdAt": "2025-12-18T11:20:11Z"  }}