1.1.11 • Published 9 months ago

@mangopay/vault-sdk v1.1.11

Weekly downloads
-
License
ISC
Repository
-
Last release
9 months ago

MangopayVault SDK - User integration guide

Installation

The MangoPay MangopayVault SDK is available on npm. See @mangopay/vault-sdk for an API reference.

npm install --save @mangopay/vault-sdk
# or
yarn add @mangopay/vault-sdk

Create a Card Registration

Send the request to https://api.mangopay.com/v2.01/clientId/cardregistrations with the input JSON data, where clientId is the ID of your MangoPay client account.

CreateCardRegistrationResult

Promise<CreateCardRegistrationResult>;
PropType
IdString
CardRegistrationURL The URL to submit the card details form toString
AccessKey A special key to use when registering a cardString
PreregistrationData A specific value to pass to the CardRegistrationURLString
errorsMgpTypedError

MgpTypedError

type MgpTypedError<T> = {
  [Property in keyof T]: string;
};

Initialisation

import { MangopayVault } from '@mangopay/vault-sdk';

const options = {
  clientId: 'MANGOPAY_CLIENT_ACCOUNT_ID',
  environment: 'SANDBOX | PRODUCTION',
};

const vault = MangopayVault.initialize(options);

How it works

The MangopayVault API provides you with tokenizePaymentMethod( );

Tokenize Payment Method

CardInfoObject

PropType
cardNumber The card number, as a string without any separatorsString
cardExpirationDate Card expiration date - should be in format MMYYString
cardCvx Card security codeString
const cardInfoObject = {
  cardNumber: '4970107111111119',
  cardExpirationDate: '1127',
  cardCvx: '123',
};

const preregistrationData = {
  id: createCardRegistrationResult.Id,
  cardRegistrationURL: createCardRegistrationResult.CardRegistrationURL,
  accessKeyRef: createCardRegistrationResult.AccessKey,
  data: createCardRegistrationResult.PreregistrationData,
};

const tokenizePaymentMethodResult = await vault.tokenizePaymentMethod(cardInfoObject, preregistrationData);

TokenizePaymentMethodResult

Promise<UpdateCardRegistrationOutput>;

UpdateCardRegistrationOutput

PropType
IdString
CardRegistrationURL The URL to submit the card details form toString
AccessKey A special key to use when registering a cardString
PreregistrationData A specific value to pass to the CardRegistrationURLString
CardId The ID of a cardString
errorsMgpTypedError
1.1.11

9 months ago

1.1.10

10 months ago

1.1.10-beta.0

10 months ago

1.1.9-beta.0

12 months ago

1.1.8-beta.1

1 year ago

1.1.9-beta.1

12 months ago

1.1.8-beta.2

1 year ago

1.1.8-beta.0

1 year ago

1.1.9

12 months ago

1.1.8

1 year ago

1.1.7

1 year ago

1.1.6

1 year ago

1.1.6-beta.1

1 year ago

1.1.6-alpha.3

1 year ago

1.1.6-alpha.4

1 year ago

1.1.6-alpha.1

1 year ago

1.1.6-alpha.2

1 year ago

1.1.6-alpha.0

1 year ago

1.1.5

1 year ago

1.1.5-beta.1

1 year ago

1.1.5-beta.0

1 year ago

1.1.4

1 year ago

1.1.4-beta.0

1 year ago

1.1.3

1 year ago

1.1.2

1 year ago

1.1.2-beta.1

1 year ago

1.1.2-beta.0

1 year ago

1.1.1

1 year ago

1.1.1-beta.0

1 year ago

1.1.0

1 year ago

1.0.18-alpha.5

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago

1.0.15-alpha.1

1 year ago

1.0.15-alpha.2

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.11

2 years ago

1.0.9

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.1-alpha.2

2 years ago

1.0.1-alpha.1

2 years ago

1.0.1-alpha.0

2 years ago

1.0.11

2 years ago

1.0.12

2 years ago

0.0.10

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago