From version 75.1
edited by David Persson
on 2020/01/30 13:01
To version 75.2
edited by David Persson
on 2020/01/30 15:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -16,6 +16,32 @@
16 16  
17 17  [[image:1579213343157-343.png||height="325" width="346"]]
18 18  
19 +(% id="HRoutesegments" %)
20 +== Route segments ==
21 +
22 +Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
23 +
24 +The below route is an example of a route towards resource3Id, to operate on this resource you must also include the ids of its parentresources in the route.
25 +//api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**//
26 +
27 +|=Route segment|=Description
28 +|Subdomain|which subdomain under "ledger" to call, (credit-account / credit-account-acquiring etc.)
29 +|LedgerNumber|The ledger identifier/number at PayEx
30 +|resource1Id|Identifier of resource1
31 +|resource2Id|identifier of resource2, subresource to resource1
32 +|resource3Id|identifier of resource3, subresource to resource2
33 +
34 +(% class="wikigeneratedid" %)
35 +== The examples in this documentation will follow the below mapping ==
36 +
37 +|(% style="width:488px" %) |(% style="width:2271px" %)
38 +|(% style="width:488px" %)LedgerNumber|(% style="width:2271px" %)XXX
39 +|(% style="width:488px" %)Accounts|(% style="width:2271px" %)NNN
40 +|(% style="width:488px" %)Bills|(% style="width:2271px" %)YYY
41 +|(% style="width:488px" %)Cards|(% style="width:2271px" %)
42 +|(% style="width:488px" %) |(% style="width:2271px" %)
43 +|(% style="width:488px" %) |(% style="width:2271px" %)
44 +
19 19  == Accounts ==
20 20  
21 21  The **accounts** resource is located under **ledger/credit-account/v1/ **api**. **The accounts- and its sub-resources are used to create, read and modify information related to a credit-account.

Tips

You can click on the arrows next to the breadcrumb elements to quickly navigate to sibling and children pages.

Need help?

If you need help with XWiki you can contact: