Quickstart

7 min

environments sandbox production partner platform link https //portal sandbox boompay app https //portal production boompay app api host https //api sandbox boompay app https //api production boompay app sdk iframe url https //sdk sandbox boompay app https //web boompay app to get started with the boom sdk, follow these 3 steps 1\ generate an access key and a secret key using the https //portal boompay app/login in the boom partner platform, navigate to https //portal boompay app/settings > https //portal boompay app/settings/developers to generate an access key and a secret key make sure to save the secret key after you generate it, as you won't be able to view it again in the partner platform 2\ exchange your access key and secret key for an api token curl location 'https //api production boompay app/partner/v1/authenticate' \\ \ header 'content type application/json' \\ \ data '{ "access key" {{access key}}, "secret key" {{secret key}} }' 3\ create a customer authentication token and sync with our user database curl location 'https //api production boompay app/partner/v1/customers' \\ \ header 'authorization bearer {{api token}}' \\ \ header 'content type application/json' \\ \ data raw '{ "first name" "john", "last name" "doe", "email" "test\@email com", "phone" "1234567890", "dob" "1999 09 27" }' email and phone must be unique, meaning neither element should be present in boom's system sample of fullstack react/node implementation with plaid processor token https //github com/boompay/sdk integration sample sample iframe implementation example for vanilla js this section is relevant for plaid copy link flow for plaid shared token see docid\ nf44by7fk3vgd pvg0ptn page or docid\ od3a2gm3bsnyt0odyeor5 above an iframe embedded environment is fully supported with the boom sdk iframe supports the following query params for customization token required to launch authenticated experience we emit an auth error event if the token fails authentication html demo you need to handle a close and auth error event please refer to the following link for more details on handling those events https //developer mozilla org/en us/docs/web/api/window/postmessage