SettlementTransferEventData

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

settlementTransfer objectrequired

iduuid

The ePay ID of the settlement transfer

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

settlementIdsstring[]

List of MIDs included in the settlement report.

postingDatedate

The posting date of the transfer as registered by the acquirer

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

adjustments object[]

Array [

typestring

The type of adjustment, this tells you reason for the adjust and who the money is paid to.

The types [RESERVE, ADJUSTMENT, FEE] is used for transfer adjustments.

• RESERVE: The amounts deducted and released from the merchant’s collateral
• FEE: Fees charged for different services provided by the acquirer (e.g., wire transfer fee).
• ADJUSTMENT: Amounts debited or credited to the merchant to adjust the merchant balance.

The types [ACQUIRER_FEE, INTERCHANGE_FEE, SCHEME_FEE] is used for transaction adjustments.

• ACQUIRER_FEE: Fees that is charged by and goes to the acquirer.
• INTERCHANGE_FEE: Fees that goes to the issuing bank of the paying card.
• SCHEME_FEE: Fees that goes to the scheme network such as Visa and Mastercard.

Possible values: [RESERVE, ADJUSTMENT, FEE, ACQUIRER_FEE, INTERCHANGE_FEE, SCHEME_FEE]

Example: FEE

amountstring

Numeric string, negative for fees

Example: -1.00

descriptionstring

Human-readable description

Example: discount_rate

]

createdAtdate-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"
      }
    ],
    "createdAt": "2025-12-18T11:20:11Z"
  }
}