Deposit returned

webhook

deposit.returned

A deposit that had posted was returned by the bank and has left the wallet. transaction is the statement line that takes it back out, type: DEPOSIT_RETURN, direction: DEBIT.

Payload

Fields every webhook event carries.

eventId

uuid

required

Deliveries of the same event share it, and X-PayKeeper-Event-Id repeats it. Deduplicate on it.

sequenceNumber

integer

required

≥ 1

Counts up by one for each event on this wallet. A jump means an event you have not seen.

eventType

string

enum

required

Which event this is.

Allowed:

occurredAt

date-time

required

When the change happened.

walletId

uuid

required

The wallet the event is about. For payout and disbursement events, the source wallet; for transfer.received, the wallet that received the money.

walletExternalId

string | null

required

Your externalId for the wallet.

transaction

object

required

The statement line that takes the deposit back out, type: DEPOSIT_RETURN, direction: DEBIT.

Headers

X-PayKeeper-Signature

string

required

^[0-9a-f]{64}$

Hex HMAC-SHA256 of {X-PayKeeper-Timestamp}.{raw body}, keyed with the endpoint's signing secret.

X-PayKeeper-Timestamp

string

required

^[0-9]+$

Unix seconds when the event was first sent. Retries repeat it.

X-PayKeeper-Event-Id

uuid

required

The event's eventId. Deliveries of the same event share it.

Response

200

Any 2xx acknowledges the event. Answer within five seconds.

Loading…