Skip to content

Latest commit

 

History

History
417 lines (357 loc) · 12.4 KB

STOREDVALUE.md

File metadata and controls

417 lines (357 loc) · 12.4 KB
Raw

Monetary Reporting API

Stored Value Reporting Requests

Account Transactions

All transactions for a single stored value account

GET /v1/storedvalue/{Id}/transactions

Request Fields (bold fields required)

Field Type Description Location
Id number SV Account Number URL

Response JSON

[
   {
      "Reference": 102394,
      "DatetimeLocal": "2018-01-31T12:10:49.84",
      "Trancode": "Sale",
      "Status": "Approved",
      "Message": null,
      "Invoice": "T3HB1LLS",
      "Account": "8383830000000018",
      "Amount": -5.95,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null,
      "Business": "Dgo - Main Location"
   },
   {
      "Reference": null,
      "DatetimeLocal": "2018-01-31T12:10:49.84",
      "Trancode": "Set",
      "Status": "Error",
      "Message": "Invalid Account/CVV/Identifier",
      "Invoice": null,
      "Account": "8282820000001894",
      "Amount": null,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null,
      "Business": "Den - Cherry Creek Location"
   }
]

Business Credit Current

Current credit on business owned accounts

GET /v1/storedvalue/creditCurrent

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"-225.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"-113.00"
   }
]

Business Credit Effective

Credit as of effective date on business owned accounts

GET /v1/storedvalue/creditEffective?EffectiveDate={EffectiveDate}

Request Fields (bold fields required)

Field Type Description Location
EffectiveDate 1 Date Credit as of beginning of this day. URL

1 Date format is yyyy-MM-dd.

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"-25.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"-113.00"
   }
]

Business Liability Current

Current liability on business owned accounts

GET /v1/storedvalue/liabilityCurrent

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"225.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"113.00"
   }
]

Business Liability Effective

Liability as of effective date on business owned accounts

GET /v1/storedvalue/liabilityEffective?EffectiveDate={EffectiveDate}

Request Fields (bold fields required)

Field Type Description Location
EffectiveDate 1 Date Liability as of beginning of this day. URL

1 Date format is yyyy-MM-dd.

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"25.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"113.00"
   }
]

Business Reconcile

Net change in liability for the date range partitioned by group

GET /v1/storedvalue/reconcile?StartDate={StartDate}&EndDate={EndDate}

Request Fields (bold fields required)

Field Type Description Location
StartDate 1 Date Start date URL
EndDate 1 Date End date URL

1 Date format is yyyy-MM-dd.

Response JSON

[  
   {  
      "GroupId":1,
      "Group":"Bark & Meow",
      "Amount":"-11.23"
   }
]

Business Transactions

Transactions in the date range

GET /v1/storedvalue/transactions?StartDate={StartDate}&EndDate={EndDate}

Request Fields (bold fields required)

Field Type Description Location
StartDate 1 Date Start date URL
EndDate 1 Date End date URL

1 Date format is yyyy-MM-dd.

Response JSON

[
   {
      "Reference": 102394,
      "DatetimeLocal": "2018-01-30T03:58:20.93",
      "Trancode": "Sale",
      "Status": "Approved",
      "Message": null,
      "Invoice": "T3HB1LLS",
      "Account": "8383830000000018",
      "Amount": -5.95,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null
   },
   {
      "Reference": null,
      "DatetimeLocal": "2018-01-30T03:58:20.93",
      "Trancode": "Set",
      "Status": "Error",
      "Message": "Invalid Account/CVV/Identifier",
      "Invoice": null,
      "Account": "8282820000001894",
      "Amount": null,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null
   }
]

Groups Credit Current

Current credit on group owned accounts

GET /v1/storedvalue/groups/{id}/creditCurrent

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"-225.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"-113.00"
   }
]

Groups Credit Effective

Credit as of effective date on group owned accounts

GET /v1/storedvalue/groups/{Id}/creditEffective?EffectiveDate={EffectiveDate}

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL
EffectiveDate 1 Date Credit as of beginning of this day. URL

1 Date format is yyyy-MM-dd.

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"-25.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"-113.00"
   }
]

Groups Liability Current

Current liability on group owned accounts

GET /v1/storedvalue/groups/{id}/liabilityCurrent

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"225.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"113.00"
   }
]

Groups Liability Effective

Liability as of effective date on group owned accounts

GET /v1/storedvalue/groups/{Id}/liabilityEffective?EffectiveDate={EffectiveDate}

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL
EffectiveDate 1 Date Liability as of beginning of this day. URL

1 Date format is yyyy-MM-dd.

Response JSON

[  
   {  
      "Account":"8383830000000034",
      "Balance":"25.00"
   },
   {  
      "Account":"8383830000000042",
      "Balance":"113.00"
   }
]

Groups Reconcile

Net change in liability for the date range partitioned by business

GET /v1/storedvalue/groups/{Id}/reconcile?StartDate={StartDate}&EndDate={EndDate}

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL
StartDate 1 Date Start date URL
EndDate 1 Date End date URL

1 Date format is yyyy-MM-dd.

Response JSON

[
   {
      "BusinessId": 555,
      "Business": "Dgo - Main Location",
      "Amount": 800,
      "IsHoldingBusiness": 1
   },
   {
      "BusinessId": 123,
      "Business": "Den - Cherry Creek Location",
      "Amount": -5,
      "IsHoldingBusiness": 0
   }
]

Groups Transactions

Transactions in the date range for group owned accounts

GET /v1/storedvalue/groups/{Id}/transactions?StartDate={StartDate}&EndDate={EndDate}

Request Fields (bold fields required)

Field Type Description Location
Id Integer Group Id. URL
StartDate 1 Date Start date URL
EndDate 1 Date End date URL

1 Date format is yyyy-MM-dd.

Response JSON

[
   {
      "Reference": 102394,
      "DatetimeLocal": "2018-01-31T12:10:49.84",
      "Trancode": "Sale",
      "Status": "Approved",
      "Message": null,
      "Invoice": "T3HB1LLS",
      "Account": "8383830000000018",
      "Amount": -5.95,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null,
      "BusinessID": 555,
      "Business": "Dgo - Main Location"
   },
   {
      "Reference": null,
      "DatetimeLocal": "2018-01-31T12:10:49.84",
      "Trancode": "Set",
      "Status": "Error",
      "Message": "Invalid Account/CVV/Identifier",
      "Invoice": null,
      "Account": "8282820000001894",
      "Amount": null,
      "IsBulk": false,
      "IsPromo": false,
      "VoidId": null,
      "BusinessID": 123,
      "Business": "Den - Cherry Creek Location"
   }
]