Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danibram/trustly-client
A node client to comunicate with trustly.
https://github.com/danibram/trustly-client
client nodejs payment payment-integration trustly
Last synced: about 5 hours ago
JSON representation
A node client to comunicate with trustly.
- Host: GitHub
- URL: https://github.com/danibram/trustly-client
- Owner: danibram
- License: mit
- Created: 2015-06-08T15:17:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-07-23T09:53:37.000Z (over 3 years ago)
- Last Synced: 2024-04-24T13:36:46.132Z (7 months ago)
- Topics: client, nodejs, payment, payment-integration, trustly
- Language: TypeScript
- Homepage: https://github.com/danibram/trustly-client
- Size: 1.64 MB
- Stars: 6
- Watchers: 2
- Forks: 8
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Trustly Client
[][npm-home-module][][npm-home-module][![Support link][paypal-badge]][paypal-link]
Node.js client for trustly integrations. Rewrite completely to Typescript and updated to use lasts libraries.
## Quickstart
### Installation
Install the module with: `npm install trustly-client` or `yarn add trustly-client`
### Usage
In versions **>3.0.0** all validations are removed and you are free to pass every parameter you like. For older changelog go to the tags **<3.0.0**
```javascript
// In Vanilla javascript
var client = require('trustly-client').default // Import it
var tClientKP = client(configuration) // Fill the configuration
tClientKP // Ready to use
.deposit(
{
NotificationURL: 'http://127.0.0.1:4343/notification',
EndUserID: '[email protected]',
MessageID: '111112111221',
},
{
Locale: 'es_ES',
Amount: '1.00',
Currency: 'EUR',
SuccessURL: 'http://127.0.0.1:4343/success',
FailURL: 'http://127.0.0.1:4343/fail',
}
)
.then(function (response) {
console.log(util.inspect(response, false, 20, true))
})
.catch(function (error) {
console.log(util.inspect(error, false, 20, true))
})
// In Typescript
import client from 'trustly-client' // Import it
let tClient = client(configuration) // Fill the configuration
tClientKP // Ready to use
.deposit(
{
NotificationURL: 'http://127.0.0.1:4343/notification',
EndUserID: '[email protected]',
MessageID: '111112111221',
},
{
Locale: 'es_ES',
Amount: '1.00',
Currency: 'EUR',
SuccessURL: 'http://127.0.0.1:4343/success',
FailURL: 'http://127.0.0.1:4343/fail',
}
)
.then(function (response) {
console.log(util.inspect(response, false, 20, true))
})
.catch(function (error) {
console.log(util.inspect(error, false, 20, true))
})
```
## Documentation
### Initialization
After import the library you must configure it with your data:
```javascript
import client from 'trustly-client' // Import it
let tClient = client({
username: '', // required
password: '', // required
privateKeyPath: '', // required
publicKeyPath: '', // optional
endpoint: '', // optional
environment: '', // optional (But required in production, see below!)
}) // Fill the configuration
```
This configuration is an object and this is the structure:
- [required] 'privateKeyPath': Path to you private key
- [required] 'username': Your trustly api username
- [required] 'password': Your trustly api password
- [optional] 'publicKeyPath': Path to a public key (for the general cases you don't need it, i package the trusty public key)
- [optional] 'endpoint': By default is selected depending of the environment between "" and "".
- [optional] 'environment': By default is "development", and it does the http calls to trustly development environment (`https://test.trustly.com/api/1`), if you pass production it turns to `https://trustly.com/api/1`, so remember to change that variable when you go to production
### Usage
This are the methods availables, every method accepts `data` and `params` and are the same that you have to send to trustly.
- **'deposit'** : Create a deposit request.
- **'refund'** : Create a refund request.
- **'selectAccount'** : Create a select account request.
- **'charge'** : Create a charge request.
- **'withdraw'** : Create a withdraw request.
- **'approveWithdrawal'** : Create a approve withdrawal request.
- **'denyWithdrawal'** : Create a deny withdrawal request.
- **'accountPayout'** : Create a account payout request.
- **'request'** : This creates a free request to trustly, use only for testing propouses, you have to pass this parameters `(method, params, attributes)`, and it compose and sign the trustly structure.
- **'createNotificationResponse'** : Helper that: - Verify the signature and the data from trustly - Compose the data you need to send to trustly to answer the notifications, it will be returned as an output from this method. The output should be like:
```
{
"result": {
"signature": "R9+hjuMqbsH0Ku ... S16VbzRsw==",
"uuid": "258a2184-2842-b485-25ca-293525152425",
"method": "credit",
"data": {
"status": "..."
}
},
"version":"1.1"
}
```
In the oficial docs you have all you need to manage the data [trustly official doc](https://trustly.com/en/developer/api#/notifications)
- **'verifyAndParseNotification'** : Helper to verify and parse Json the notification response
- **'composeNotificationResponse'** : Helper to compose the notification response, its accepts also custom data to send it back. You can use both (**verifyAndParseNotification**,**composeNotificationResponse**) as replacement of **createNotificationResponse**.
```javascript
console.log('- Notification is comming. √')
tClient
.createNotificationResponse(req.body)
.then(function (data) {
console.log(util.inspect(data, false, 20, true))
res.send(data)
})
.catch(function (error) {
console.log('_Error')
console.log(util.inspect(error, false, 20, true))
})
// -------------------- OR ----------------------//
console.log('- Notification is comming. √')
tClient
.verifyAndParseNotification(req.body)
.then(function (notification) {
return composeNotificationResponse(notification, {
status: 'OK',
...aditionalData,
})
})
.then(function (data) {
console.log(util.inspect(data, false, 20, true))
res.send(data)
})
.catch(function (error) {
console.log('_Error')
console.log(util.inspect(error, false, 20, true))
})
```
All trustly methods (deposit, refund, selectAccount, charge, withdraw, approveWithdrawal, denyWithdrawal) uses the parameters described in trusty documentation. [here (trustly docs)](https://trustly.com/en/developer/api#/introduction).
If is something missing please make a pull request or write an issue.
Method **'createNotificationResponse'** accepts a Json string or a Json with the notification, and compose for you te correct response for Trustly. See [tests/notification-server/test-notification-server.js](https://github.com/danibram/trustly-client/blob/master/tests/notification-server/test-notification-server.js), inside you have an already express server that you can deploy anywhere (dont forget to update with your configuration), and test the notifications.
Also it is exported helpers to sign, verify, interfaces, all configuration etc... So feel free to use it, if there is any doubt dont be shy, write an issue, a pull request or an email to me.
## Error Management
Managing errors is the key of a client, so for that trustly client always send the lastRequest and lastResponse (If there it be), and also i parse the most important parts for you according to the documentation, the final structure, is:
```javascript
var error = {
lastRequest: self._lastRequest,
lastResponse: self._lastResponse,
trustlyError: null,
clientError: null,
}
```
It seems to long but sometimes you must understand the request and the response.
If _clientError_ is filled, means that the error not comes from trustly.
If _trustlyError_ is filled, it will catch all information about the trustly error in this format (Example):
```javascript
trustlyError = {
method: 'Deposit',
uuid: 'dba2d98c-6c4e-4b9e-aa46-90027793aa14',
message: 'ERROR_DUPLICATE_MESSAGE_ID',
code: 637,
}
```
_Note: method and uuid can be null if the request contains a malformed JSON_
More information about the errors [here (trustly docs)](https://trustly.com/en/developer/api#/errormessages)
## Release History
See [CHANGELOG.md](https://github.com/danibram/trustly-client/blob/master/CHANGELOG.md)
## License
Licensed under the MIT license. 2021
[npm-home-module]: https://www.npmjs.com/package/trustly-client
[paypal-badge]: https://img.shields.io/badge/❤%20support-paypal-blue.svg?style=flat-square
[paypal-link]: https://www.paypal.me/danibram