deposit.received

curl --request POST \
  --url https://api.sand.getivy.de/api/service/webhook-event/deposit.received \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "type": "deposit.received",
  "date": "<string>",
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "received",
    "amount": 123,
    "transactionId": "<string>",
    "currency": "EUR",
    "receivedAt": "<unknown>",
    "payer": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      },
      "wallet": {
        "address": "<string>"
      }
    },
    "payee": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      },
      "wallet": {
        "address": "<string>"
      }
    },
    "returns": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "initiated",
        "amount": 123,
        "currency": "EUR",
        "createdAt": "2023-11-07T05:31:56Z",
        "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "failedAt": "2023-11-07T05:31:56Z",
        "succeededAt": "2023-11-07T05:31:56Z"
      }
    ],
    "depositId": "<string>",
    "value": {
      "currency": "<string>",
      "amount": "<string>"
    },
    "bankStatementReference": "<string>",
    "rail": "sepa_instant",
    "txHash": "<string>"
  }
}
'

POST

api

service

webhook-event

deposit.received

curl --request POST \
  --url https://api.sand.getivy.de/api/service/webhook-event/deposit.received \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "type": "deposit.received",
  "date": "<string>",
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "received",
    "amount": 123,
    "transactionId": "<string>",
    "currency": "EUR",
    "receivedAt": "<unknown>",
    "payer": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      },
      "wallet": {
        "address": "<string>"
      }
    },
    "payee": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      },
      "wallet": {
        "address": "<string>"
      }
    },
    "returns": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "initiated",
        "amount": 123,
        "currency": "EUR",
        "createdAt": "2023-11-07T05:31:56Z",
        "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "failedAt": "2023-11-07T05:31:56Z",
        "succeededAt": "2023-11-07T05:31:56Z"
      }
    ],
    "depositId": "<string>",
    "value": {
      "currency": "<string>",
      "amount": "<string>"
    },
    "bankStatementReference": "<string>",
    "rail": "sepa_instant",
    "txHash": "<string>"
  }
}
'

Body

application/json

Data of the webhook event

string

required

The unique id for the webhook.

type

enum<string>

required

Available options:

deposit.received

date

string

required

The date of the webhook.

payload

object

required

The received deposit data.

Show child attributes

payload.id

string<uuid>

required

The ID of the deposit

payload.status

enum<string>

required

The status of the deposit

Available options:

received

payload.amount

number

required

The amount of the deposit

payload.transactionId

string

required

payload.currency

enum<string>

required

The currency of the deposit

Available options:

EUR,

GBP,

PLN,

SEK,

DKK,

USDC

payload.receivedAt

any

required

payload.payer

object

required

The payer account identifier

Show child attributes

payload.payer.type

enum<string>

required

Available options:

iban,

sort_code,

bank_code,

bban,

wallet

payload.payer.iban

object

Show child attributes

payload.payer.iban.accountHolderName

string

required

Minimum string length: 1

payload.payer.iban.iban

string

required

payload.payer.iban.bic

string

payload.payer.sortCode

object

Show child attributes

payload.payer.sortCode.accountHolderName

string

required

Minimum string length: 1

payload.payer.sortCode.sortCode

string

required

payload.payer.sortCode.accountNumber

string

required

Maximum string length: 8

payload.payer.bankCode

object

Show child attributes

payload.payer.bankCode.accountHolderName

string

required

Minimum string length: 1

payload.payer.bankCode.code

string

required

payload.payer.bankCode.accountNumber

string

required

payload.payer.bban

object

Show child attributes

payload.payer.bban.accountHolderName

string

required

Minimum string length: 1

payload.payer.bban.bban

string

required

payload.payer.bban.bic

string

payload.payer.wallet

object

Show child attributes

payload.payer.wallet.address

string

required

The blockchain wallet address

payload.payee

object

required

The payee account identifier

Show child attributes

payload.payee.type

enum<string>

required

Available options:

iban,

sort_code,

bank_code,

bban,

wallet

payload.payee.iban

object

Show child attributes

payload.payee.iban.accountHolderName

string

required

Minimum string length: 1

payload.payee.iban.iban

string

required

payload.payee.iban.bic

string

payload.payee.sortCode

object

Show child attributes

payload.payee.sortCode.accountHolderName

string

required

Minimum string length: 1

payload.payee.sortCode.sortCode

string

required

payload.payee.sortCode.accountNumber

string

required

Maximum string length: 8

payload.payee.bankCode

object

Show child attributes

payload.payee.bankCode.accountHolderName

string

required

Minimum string length: 1

payload.payee.bankCode.code

string

required

payload.payee.bankCode.accountNumber

string

required

payload.payee.bban

object

Show child attributes

payload.payee.bban.accountHolderName

string

required

Minimum string length: 1

payload.payee.bban.bban

string

required

payload.payee.bban.bic

string

payload.payee.wallet

object

Show child attributes

payload.payee.wallet.address

string

required

The blockchain wallet address

payload.returns

object[]

required

Show child attributes

payload.returns.id

string<uuid>

required

The ID of the return

payload.returns.depositId

string<uuid>

required

The ID of the associated deposit

payload.returns.status

enum<string>

required

The status of the return

Available options:

initiated,

succeeded,

failed,

returned

payload.returns.amount

number

required

The amount of the return

payload.returns.currency

enum<string>

required

The currency of the return

Available options:

EUR,

GBP,

PLN,

SEK,

DKK,

USDC

payload.returns.createdAt

string<date-time>

required

The date and time the return was created

payload.returns.transactionId

string<uuid>

The ID of the resulting return transaction

payload.returns.failedAt

string<date-time>

The date and time the return failed if applicable

payload.returns.succeededAt

string<date-time>

The date and time the return succeeded if applicable

payload.depositId

string

required

Deprecated: use id instead

payload.value

object

required

Show child attributes

payload.value.currency

string

required

Deprecated: use currency instead

payload.value.amount

string

required

Deprecated: use amount instead

payload.bankStatementReference

string

payload.rail

enum<string>

The payment rail or blockchain used for the deposit

Available options:

sepa_instant,

faster_payments,

sepa,

elixir,

express_elixir,

sek_account_to_account,

sumclearing,

straksclearing,

swift,

internal,

target,

ETH,

ETH-SEPOLIA,

SOL,

SOL-DEVNET,

MATIC,

MATIC-AMOY

payload.txHash

string

The transaction hash for crypto deposits

Response

200

payout.failed fx.initiated

⌘I

Getting Started

Events

deposit.received

Body

Response