@transferwise/approve-api-action-helpers

Approve api action helpers

A tiny library that lets you handle Strong Customer Authentication (SCA) required calls easily.

Usage

Installing

npm install @transferwise/approve-api-action-helpers to install it.

Consuming

This library exports a create function for SCA protected requests. It returns a request wrapper that can be used like a regular fetch request. Use it as follows:

import { create, Flow, Mode } from '@transferwise/approve-api-action-helpers';

const request = create({
  flow: Flow.IFRAME,
  mode: Mode.PRODUCTION,
});

const res = await request('https://my-backend-api.com/sca-protected-call', { method: 'GET', ... });

When the backend returns that SCA is required, it will run the user through an SCA flow and retry that request. Also, it will throw an error if you get a 4xx or 5xx response.

NB! make sure that your backend proxies 'x-2fa-approval' response header to the frontend and forwards it back to TransferWise when this library passes it back. Also please reflect the response status (403) back to the frontend.

Configuration options

key	optional	default	alternatives
flow	yes	Flow.IFRAME	Flow.TAB
mode	yes	Mode.PRODUCTION	Mode.SANDBOX

Example

iFrame flow

New tab flow