-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from Mangopay/feature/mandates
Mandates Feature
- Loading branch information
Showing
9 changed files
with
589 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| # Mandates | ||
|
|
||
| [MangoPay Mandates API Reference](https://docs.mangopay.com/endpoints/v2.01/mandates) | ||
|
|
||
|
|
||
|
|
||
| * * * | ||
|
|
||
| ### Mandates.create(mandate, callback, options) | ||
|
|
||
| Create a new Mandate | ||
|
|
||
| **Parameters** | ||
|
|
||
| **mandate**: `Object`, Mandate object | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Promise of the request | ||
|
|
||
|
|
||
| ### Mandates.getAll(callback, options) | ||
|
|
||
| Get all mandates | ||
|
|
||
| **Parameters** | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Request promise | ||
|
|
||
|
|
||
| ### Mandates.get(mandateId, callback, options) | ||
|
|
||
| Get mandate by ID | ||
|
|
||
| **Parameters** | ||
|
|
||
| **mandateId**: `number`, Mandate identifier | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Request promise | ||
|
|
||
|
|
||
| ### Mandates.cancel(mandateId, callback, options) | ||
|
|
||
| Cancel a mandate | ||
|
|
||
| **Parameters** | ||
|
|
||
| **mandateId**: `number`, Mandate identifier | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Request promise | ||
|
|
||
|
|
||
| ### Mandates.getMandatesForUser(userId, callback, options) | ||
|
|
||
| Gets user's mandates | ||
|
|
||
| **Parameters** | ||
|
|
||
| **userId**: `number`, User identifier | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Request promise | ||
|
|
||
|
|
||
| ### Mandates.getMandatesForBankAccount(userId, bankAccountId, callback, options) | ||
|
|
||
| Gets bank account mandates | ||
|
|
||
| **Parameters** | ||
|
|
||
| **userId**: `number`, User identifier | ||
|
|
||
| **bankAccountId**: `number`, Bank Account identifier | ||
|
|
||
| **callback**: `function`, Callback function | ||
|
|
||
| **options**: `Object`, Request options | ||
|
|
||
| **Returns**: `Object`, Request promise | ||
|
|
||
|
|
||
|
|
||
| * * * | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| var _ = require('underscore'); | ||
| var Model = require('../Model'); | ||
|
|
||
| var Mandate = Model.extend({ | ||
| defaults: { | ||
| /** | ||
| * When the item was created | ||
| */ | ||
| CreationDate: null, | ||
| /** | ||
| * Custom data that you can add to this item | ||
| */ | ||
| Tag: null, | ||
| /** | ||
| * An ID of a Bank Account | ||
| */ | ||
| BankAccountId: null, | ||
| /** | ||
| * The object owner's UserId | ||
| */ | ||
| UserId: null, | ||
| /** | ||
| * The URL to redirect to after payment (whether successful or not) | ||
| */ | ||
| ReturnURL: null, | ||
| /** | ||
| * The URL to redirect to user to for them to proceed with the payment | ||
| */ | ||
| RedirectURL: null, | ||
| /** | ||
| * The URL to download the mandate | ||
| */ | ||
| DocumentURL: null, | ||
| /** | ||
| * The language to use for the mandate confirmation page - needs to be the ISO code of the language | ||
| */ | ||
| Culture: null, | ||
| /** | ||
| * The type of mandate, but will only be completed once the mandate has been submitted | ||
| */ | ||
| Scheme: null, | ||
| /** | ||
| * The status of the mandate | ||
| */ | ||
| Status: null, | ||
| /** | ||
| * The result code | ||
| */ | ||
| ResultCode: null, | ||
| /** | ||
| * A verbal explanation of the ResultCode | ||
| */ | ||
| ResultMessage: null, | ||
| /** | ||
| * The execution type for creating the mandate | ||
| */ | ||
| ExecutionType: 'WEB', | ||
| /** | ||
| * The type of Mandate, defaults to DIRECT_DEBIT | ||
| */ | ||
| MandateType: 'DIRECT_DEBIT' | ||
| } | ||
| }); | ||
|
|
||
| module.exports = Mandate; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| module.exports = { | ||
| Created: 'CREATED', | ||
| Submitted: 'SUBMITTED', | ||
| Active: 'ACTIVE', | ||
| Failed: 'FAILED' | ||
| }; |
Oops, something went wrong.