API Reference

Deposit posted

webhook
deposit.posted

A deposit posted to the wallet and counts in its balance. transaction is the new line of the wallet's statement, type: DEPOSIT.

Payload

Fields every webhook event carries.

uuid
required

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

integer
required
≥ 1

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

string
enum
required

Which event this is.

Allowed:
date-time
required

When the change happened.

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.

string | null
required

Your externalId for the wallet.

transaction
object
required

The statement line, type: DEPOSIT, direction: CREDIT.

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

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

string
required
^[0-9]+$

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

uuid
required

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

Response
200

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

Updated 10 days ago

Did this page help you?
LoadingLoading…

Updated 10 days ago

Did this page help you?