External account status changed

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication.

Headers

webhook-id

string

required

The unique identifier of the webhook.

webhook-timestamp

integer

required

The timestamp of the webhook, in seconds after the Unix epoch.

webhook-signature

string

required

The signature of the webhook.

Body

application/json

External account status changed event.

The webhook event information.

string<uuid>

required

The id of the event.

type

string

required

The type of event.

createdAt

string<date-time>

required

The date and time when the event was created.

data

object

required

The event payload.

Show child attributes

data.externalAccount

object

required

Show child attributes

data.externalAccount.id

string<uuid>

required

The unique identifier of the external account.

data.externalAccount.ownerId

string<uuid>

required

The unique identifier of the user that owns the account.

data.externalAccount.type

enum<string>

required

The type of the external account.

Available options:

card,

bank

data.externalAccount.status

enum<string>

required

The status of the external account.

Available options:

processing,

ok,

expired,

failed,

restricted,

blocked

data.externalAccount.label

string

required

The label of the external account.

data.externalAccount.asset

string

required

The asset in which the external account is denominated.

data.externalAccount.features

enum<string>[]

required

The features of the external account.

Available options:

withdraw,

deposit

data.externalAccount.details

Card · object

required

The details of the external account based on the type and network.

Card
Bank (FPS)

Show child attributes

data.externalAccount.details.last4Digits

string

required

The last 4 digits of the card number.

data.externalAccount.details.expiryDate

object

required

The expiry date of the card.

Show child attributes

data.externalAccount.details.expiryDate.month

integer

required

The expiry month of the card.

data.externalAccount.details.expiryDate.year

integer

required

The expiry year of the card.

data.externalAccount.details.octSupport

enum<string>

required

The support for Open Credit Transfer (withdrawals) for the card.

Available options:

unknown,

supported,

unsupported

data.externalAccount.details.type

enum<string>

The type of the card, available if card was recognized.

Available options:

credit,

debit

data.externalAccount.createdAt

string<date-time>

required

The time at which the external account was created.

data.externalAccount.updatedAt

string<date-time>

required

The last time at which the external account was updated.

data.externalAccount.statusDetails

object

The details of the status of the external account.

Show child attributes

data.externalAccount.statusDetails.reason

enum<string>

required

The reason why the external account is in its current status.

Available options:

card-data-invalid,

card-declined-by-bank,

card-expired,

card-permanently-declined-by-bank,

card-unauthorized,

card-unsupported,

bank-account-holder-name-mismatch,

velocity,

under-review,

unspecified-error

data.externalAccount.network

string

The network that the external account corresponds to.

Response

200

Return a 200 status to indicate that the data was received successfully.

Core API

Topper API

Widgets API

External account status changed

Authorizations

Headers

Body

Response