Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlbarrdahl/swish-payments
Node.js library for the Swish API
https://github.com/carlbarrdahl/swish-payments
Last synced: 29 days ago
JSON representation
Node.js library for the Swish API
- Host: GitHub
- URL: https://github.com/carlbarrdahl/swish-payments
- Owner: carlbarrdahl
- License: mit
- Created: 2018-02-09T17:57:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T22:45:09.000Z (almost 2 years ago)
- Last Synced: 2024-08-04T01:11:49.345Z (4 months ago)
- Language: TypeScript
- Homepage: https://squish-platform.github.io/swish-payments/
- Size: 704 KB
- Stars: 10
- Watchers: 4
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-sweden - JavaScript - sweden/issues/15). (Finance)
README
# Swish Payments Library
The Swish Payments library provides convenient access to Swish API from server-side applications.
## Documentation
## Installation
Install the package with:
npm install swish-payments --save
## Usage
```js
import Swish from "swish-payments"// The package needs to be configured with your Swish certificate and passphrase.
const swish = new Swish({
endpoint: "https://mss.swicpc.bankgirot.se/swish-cpcapi/api/v1",
serverIP: "213.132.115.94:443",
cert: {
pfx: fs.readFileSync(__dirname + "/ssl/1231181189.p12"),
passphrase: "swish"
}
})// Setup payment request webook
app.post("/paymentrequests", swish.createHook(async payment => {
console.log("incoming payment: ", payment)// Refund payment
const refund = await swish.refundRequest({
originalPaymentReference: payment.id,
callbackUrl: "https://example.com/refunds/" // should be absolute url of webhook above
})}))
// Setup refund request webook
app.post("/refunds", swish.createHook(refund =>
console.log("incoming refund: ", refund)
))const token = await swish.paymentRequest({
callbackUrl: "https://example.com/paymentrequests/", // should be absolute url of webhook above
payerAlias: "46700123456",
payeeAlias: "1231181189",
amount: "100.00",
message: "message",
})
// 900D843722644C149995AC246E14D8C6const payment = await swish.getPayment(token)
/*
{ errorCode: null,
errorMessage: null,
id: 'D59CD1A48F764B88BE852F4B8ED944B3',
payeePaymentReference: null,
paymentReference: null,
callbackUrl: 'https://example.com/hooks/payments/',
payerAlias: '46700123456',
payeeAlias: '1231181189',
amount: 100,
currency: 'SEK',
message: 'message',
status: 'CREATED',
dateCreated: '2018-02-09T16:49:40.201Z',
datePaid: null }
*/
```