Events

Gr4vy Embed accepts an onEvent parameter that can be used to listen to certain events emitted from the form.

setup({

element: '.container',

...,

onEvent: (name, data) => {

...

}

})

Currently, we Gr4vy Embed emits the following events.

agumentError

Returned when the initial input (element, options) are incorrectly formatted or missing.

{

"code": "argumentError",

"option": "currency",

"message": "must be a valid number"

}

formUpdate

Returned when the form updates. Currently this only informs the developer if the form is valid.

{

"valid": false

}

transactionCreated

Returns a full transaction object when the transaction was successfully created.

{

"type": "transaction",

"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",

"status": "pending",

...

}

paymentMethodSelected

Returns a full payment method object when a payment method was selected and submitted in Gr4vy Embed. The method could have been a newly created payment method or one previously stored.

{

"type": "payment-method",

"id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",

"status": "stored",

...

}

apiError

Returned when the form encounters an API error.

{

"type": "error",

"code": "unauthorized",

"status": 401,

"message": "No valid API authentication found",

"details": []

}