@mft/moneyhub-api-client 4.12.0 → 4.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +6 -6
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mft/moneyhub-api-client",
3
- "version": "4.12.0",
3
+ "version": "4.12.1",
4
4
  "description": "Node.JS client for the Moneyhub API",
5
5
  "main": "src/index.js",
6
6
  "scripts": {
package/readme.md CHANGED
@@ -1100,10 +1100,10 @@ This is a helper function that returns an authorize url to authorize a payment t
1100
1100
 
1101
1101
  ```javascript
1102
1102
  const url = await moneyhub.getPaymentAuthorizeUrl({
1103
- bankId: "Bank id to authorise payment from",
1104
- payeeId: "Id of payee",
1103
+ bankId: "Bank id to authorise payment from", // required
1104
+ payeeId: "Id of payee", // required
1105
1105
  payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
1106
- payerId: "Id of payer", // requird only if payerType is defined
1106
+ payerId: "Id of payer", // required only if payerType is defined
1107
1107
  payerType: "Payer type [mh-user-account]", // required only if payerId is used
1108
1108
  amount: "Amount in pence to authorize payment",
1109
1109
  payeeRef: "Payee reference",
@@ -1248,10 +1248,10 @@ This is a helper function that returns an authorize url to authorize a standng o
1248
1248
 
1249
1249
  ```javascript
1250
1250
  const url = await moneyhub.getStandingOrderAuthorizeUrl({
1251
- bankId: "Bank id to authorise payment from",
1252
- payeeId: "Id of payee",
1251
+ bankId: "Bank id to authorise payment from", // required
1252
+ payeeId: "Id of payee", // required
1253
1253
  payeeType: "Payee type [api-payee|mh-user-account]", // optional - defaults to api-payee
1254
- payerId: "Id of payer", // requird only if payerType is defined
1254
+ payerId: "Id of payer", // required only if payerType is defined
1255
1255
  payerType: "Payer type [mh-user-account]", // required only if payerId is used
1256
1256
  reference: "The reference for standing order",
1257
1257
  frequency: {