{"type":"doc","content":[{"type":"layoutSection","marks":[{"type":"breakout","attrs":{"mode":"full-width"}}],"content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"Each account has a payment history that details financial transactions made against an account. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Payment histories for all accounts","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"REST API","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"ead48f15-11b5-484b-bda9-7ecb908d9ba0"}}]}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"Payment History","type":"text","marks":[{"type":"link","attrs":{"href":"https://debitsuccess.stoplight.io/docs/debitsuccess-api/CustomerServicesApi.yaml/paths/~1payments/get"}}]},{"text":" endpoint of Customer Services API with the appropriate query parameters to retrieve the desired results:","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"GET","localId":"0edcaa9e-f802-424a-a7fd-a031e0950dc1"}},{"text":" https:///CustomerServices/v1.0","type":"text"},{"text":"/payments","type":"text","marks":[{"type":"strong"}]},{"text":"[?fromDatetime][&toDatetime]","type":"text"},{"text":"[&businessAccountId]","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"07f99541-6233-4ea2-ba59-6153093062e6"}}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"businessAccountId","type":"text","marks":[{"type":"code"}]},{"text":" query parameter returns all the transactions of all accounts associated with the business.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fromDatetime","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"toDatetime","type":"text","marks":[{"type":"code"}]},{"text":" are used to indicate the date range for the transactions","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SOAP WS","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"GetPaymentHistoryForDateRange","type":"text","marks":[{"type":"link","attrs":{"href":"https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/1066533172/GetPaymentHistoryForDateRange+GetPaymentHistoryWithFeesForDateRange"}}]},{"text":" returns the payment histories for all accounts associated with the requesting user, where the transaction date falls in a ","type":"text"},{"text":"supplied range of dates","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"960a866a-01cc-4d54-acf4-37fd8953d248"}}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample request","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"f2bbfad1-e5bc-4d0b-97d8-545d3db81025"}}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n 2020-08-10\n 123\n ReqInit1\n \n #password\n username\n \n 2020-07-11\n 2020-07-09\n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample Response","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n 00000000-0000-0000-0000-000000000000\n \n \n \n \n 2020-08-10T16:13:01.2157238+12:00\n 04fd4635-df49-4420-b4ff-6501c33e8f64\n \n \n 00\n Success\n Info\n \n \n Succeed\n \n \n \n DEA2885115\n 6046386\n \n MEL28\n \n 2.00\n OneOffPayment\n 2020-07-10T10:15:54.857\n NoError\n 1530462302\n CreditCard\n 0\n 0.06\n 0\n \n \n \n DEA2885115\n 6046387\n Chocolate cake - Pay API\n MEL28\n \n 125.35\n OneOffPayment\n 2020-07-10T10:37:00.603\n NoError\n 1530462303\n CreditCard\n 0\n 3.76\n 0\n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Payment history of a single account","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"REST API","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"30948507-b7fa-45d8-9fed-3d4df11a5c25"}}]}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"Payment History","type":"text","marks":[{"type":"link","attrs":{"href":"https://debitsuccess.stoplight.io/docs/debitsuccess-api/CustomerServicesApi.yaml/paths/~1payments/get"}}]},{"text":" endpoint of Customer Services API with the appropriate query parameters to retrieve the desired results:","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"GET","localId":"87a5bd56-afaa-4435-9911-49e0af3974d0"}},{"text":" https:///CustomerServices/v1.0","type":"text"},{"text":"/payments","type":"text","marks":[{"type":"strong"}]},{"text":"[?accountId]","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"accountId","type":"text","marks":[{"type":"code"}]},{"text":" query parameter returns all the transactions for the specified account.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fromDatetime","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"toDatetime","type":"text","marks":[{"type":"code"}]},{"text":" are used to indicate the date range for the transactions","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SOAP WS","type":"text"}]},{"type":"paragraph","content":[{"text":"To retrieve the payment history of a single account use the ","type":"text"},{"text":"GetPaymentHistoryByAccountId","type":"text","marks":[{"type":"link","attrs":{"href":"https://debitsuccess.atlassian.net/wiki/spaces/DDE/pages/1066565913/GetPaymentHistoryByAccountId+GetPaymentHistoryWithFeesByAccountId"}}]},{"text":" method.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample request","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n 2020-08-10\n 123\n ReqInit1\n \n #password\n username\n \n DEA2885115\n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample Response","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n 00000000-0000-0000-0000-000000000000\n \n \n \n \n 2020-08-10T16:17:17.0032176+12:00\n 18837869-d815-42d4-ae49-7f55badfe548\n \n \n 00\n Success\n Info\n \n \n Succeed\n \n \n \n DEA2885115\n 6046397\n Chocolate cake - Pay API\n MEL28\n \n 125.35\n OneOffPayment\n 2020-07-15T07:34:38.843\n NoError\n 1530462314\n DirectCreditMasterOrVisa\n 0\n 3.76\n 0\n \n \n \n DEA2885115\n 6046387\n Chocolate cake - Pay API\n MEL28\n \n 125.35\n OneOffPayment\n 2020-07-10T10:37:00.603\n NoError\n 1530462303\n DirectCreditMasterOrVisa\n 0\n 3.76\n 0\n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Related Articles","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"contentbylabel","parameters":{"macroParams":{"showLabels":{"value":"false"},"showSpace":{"value":"false"},"excerptType":{"value":"simple"},"cql":{"value":"label in ( \"getpaymenthistorybyaccountid\" , \"GetPaymentHistoryForDateRange\" )"}},"macroMetadata":{"macroId":{"value":"3ddfe311-6374-4991-9ae0-18ff1f5dca69"},"schemaVersion":{"value":"4"},"title":"Content by Label"}},"localId":"56ecf266-7e8f-4b07-bafb-cd2e1e314758"}}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"On this page:","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"879e6def-dfa9-4ff7-846d-29ad8c78bd89"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"eefa938e-9dda-4494-848a-2a2bc9452755"}}]}]},{"type":"paragraph"}],"version":1}

Browser not supported