From version 4.1
edited by David Persson
on 2019/12/16 11:43
To version 5.1
edited by David Persson
on 2019/12/16 12:28
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,7 +8,7 @@
8 8  
9 9  == Offers ==
10 10  
11 -==== Get ====
11 +==== List ====
12 12  
13 13  {{code language="http" title="**Request**"}}
14 14  GET /ledger/credit-account-onboarding/v1/XXX/offers HTTP/1.1
... ... @@ -23,34 +23,29 @@
23 23  HTTP/1.1 200 OK
24 24  Content-Type: application/json
25 25  
26 -{
27 - "@id" : "/ledger/credit-account-onboarding/v1/501/offers",
28 - "offers" : [
29 - {
30 - "accountProfile" : "kontotyp-1000",
31 - "title" : "kontotyp 1,000",
32 - "currency" : "NOK",
33 - "creditLimit" : 1000.00,
34 - "interestFreePurchaseMonth" : true|false,
35 - "monthlyAdminFee" : 35.00,
36 - "reminderFee" : 35.00,
37 - "interest" : 35.00,
38 - "termsAndConditions" :
39 - {
40 - "standardEuropeeanAgreements" : "https://www.payex.com/term-and-conditions/no/-----.pdf",
41 - "accountTerms" : "https://www.payex.com/term-and-conditions/no/-----.pdf"
42 - },
43 - "@id" : "/ledger/credit-account-onboarding/v1/501/offers/kontotyp-1000",
44 - "operations" :
45 - [
46 - {
47 - "title" : "apply-for-account",
48 - "href" : "/ledger/credit-account-onboarding/v1/501/offers/kontotyp-1000/applications",
49 - "action" : "post"
50 - }
51 - ]
52 - }
53 - ]
26 +{
27 + "accountProfile" : "kontotyp-1000",
28 + "title" : "kontotyp 1,000",
29 + "currency" : "NOK",
30 + "creditLimit" : 1000.00,
31 + "interestFreePurchaseMonth" : true|false,
32 + "monthlyAdminFee" : 35.00,
33 + "reminderFee" : 35.00,
34 + "interest" : 35.00,
35 + "termsAndConditions" :
36 + {
37 + "standardEuropeeanAgreements" : "https://www.payex.com/term-and-conditions/no/-----.pdf",
38 + "accountTerms" : "https://www.payex.com/term-and-conditions/no/-----.pdf"
39 + },
40 + "@id" : "/ledger/credit-account-onboarding/v1/501/offers/kontotyp-1000",
41 + "operations" :
42 + [
43 + {
44 + "title" : "apply-for-account",
45 + "href" : "/ledger/credit-account-onboarding/v1/501/offers/kontotyp-1000/applications",
46 + "action" : "post"
47 + }
48 + ]
54 54  }
55 55  {{/code}}
56 56  
... ... @@ -60,23 +60,22 @@
60 60  (% class="table-bordered table-striped" %)
61 61  |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
62 62  |(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
63 -|(% style="width:215px" %)transactionReferenceId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
64 -|(% style="width:215px" %)authorizationId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
65 -|(% style="width:215px" %)sellerNumber|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
66 -|(% style="width:215px" %)description|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
67 -|(% style="width:215px" %)validToDate|(% style="width:114px" %)date|(% style="width:118px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:586px" %)
68 -|(% style="width:215px" %)authorizeAmount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
69 -|(% style="width:215px" %)remainingAmount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
70 -|(% style="width:215px" %)currency|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
71 -|(% style="width:215px" %)captures|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)
72 -|(% style="width:215px" %)cancellations|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)
58 +|(% style="width:215px" %)accountProfile|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
59 +|(% style="width:215px" %)title|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
60 +|(% style="width:215px" %)currency|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
61 +|(% style="width:215px" %)creditLimit|(% style="width:114px" %)decimal|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
62 +|(% style="width:215px" %)interestFreePurchaseMonth|(% style="width:114px" %)bool|(% style="width:118px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:586px" %)
63 +|(% style="width:215px" %)monthlyAdminFee|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
64 +|(% style="width:215px" %)reminderFee|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
65 +|(% style="width:215px" %)termsAndConditions.standardEuropeeanAgreements|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)
66 +|(% style="width:215px" %)termsAndConditions.accountTerms|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)
73 73  
74 -== Captures ==
68 +== Applications ==
75 75  
76 76  ==== List ====
77 77  
78 78  {{code language="http" title="**Request**"}}
79 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures HTTP/1.1
73 +GET /ledger/credit-account-onboarding/v1/XXX/offers/YYY/applications HTTP/1.1
80 80  Host: -
81 81  Authorization: Bearer <Token>
82 82  Content-Type: application/json
... ... @@ -86,7 +86,7 @@
86 86  ==== Get ====
87 87  
88 88  {{code language="http" title="**Request**"}}
89 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY HTTP/1.1
83 +GET /ledger/credit-account-onboarding/v1/XXX/offers/YYY/applications/NNN HTTP/1.1
90 90  Host: -
91 91  Authorization: Bearer <Token>
92 92  Content-Type: application/json
... ... @@ -101,14 +101,23 @@
101 101  Authorization: Bearer <Token>
102 102  Content-Type: application/json
103 103  
104 -{
105 - "description": "Testbutiken, köpref. 12345689",
106 - "sellerCaptureTransactionId" : "534313",
107 - "pspTransactionId" : "d65f46sd4",
108 - "settlementBatchId" : "e98t79er8t79e8t79e",
109 - "sellerReceiptId": "12345689",
110 - "captureAmount": 200.0,
111 - "currency": "SEK"
98 +{
99 + "nationalConsumerIdentifier" : {
100 + "value" : "19101010-1010",
101 + "countryCode" : "SE"
102 + },
103 + "customerNo" : "951753456",
104 + "emailAddress" : "test@testshop.se",
105 + "cellPhone" : "+46701234456",
106 + "ipAddress": "1.1.1.1",
107 + "LegalAddress" : {
108 + "name" : "John Smith",
109 + "streetAddress" : "Teststreet",
110 + "city" : "Testcity",
111 + "coAddress" : "",
112 + "zipCode" : "12345",
113 + "countryCode" : "SE"
114 + }
112 112  }
113 113  {{/code}}
114 114  
... ... @@ -118,22 +118,32 @@
118 118  HTTP/1.1 200 OK
119 119  Content-Type: application/json
120 120  
121 -{
122 - "description": "stora coop visby, köpref. 12345689",
123 - "sellerCaptureTransactionId" : "534313",
124 - "pspTransactionId" : "",
125 - "settlementBatchId" : "",
126 - "sellerReceiptId": "12345689",
127 - "captureAmount": 200.0,
128 - "currency": "SEK",
129 - "credits": "/ledger/credit-account-acquiring/v1/501/authorizations/123/captures/852/credits",
130 - "@id": "/ledger/credit-account-acquiring/v1/501/authorizations/123/capture/852",
131 - "parentHREF": "/ledger/credit-account-acquiring/v1/501/authorizations/123",
132 - "operations": [
124 +{
125 + "nationalConsumerIdentifier" : {
126 + "value" : "19101010-1010",
127 + "countryCode" : "SE"
128 + },
129 + "status" : "awaiting-sign",
130 + "customerNo" : "951753456",
131 + "emailAddress" : "test@testshop.se",
132 + "cellPhone" : "+46701234456",
133 + "ipAddress": "1.1.1.1",
134 + "LegalAddress" : {
135 + "name" : "John Smith",
136 + "streetAddress" : "Teststreet",
137 + "city" : "Testcity",
138 + "coAddress" : "",
139 + "zipCode" : "12345",
140 + "countryCode" : "SE"
141 + },
142 + "account" : null,
143 + "@id" : "/ledger/credit-account-onboardings/v1/501/offers/kontotyp-10000/applications/1561561-54641515-56456",
144 + "parentHREF" : "/ledger/credit-account-onboardings/v1/501/offers/kontotyp-10000",
145 + "operations" : [
133 133   {
134 - "rel": "create-credit",
135 - "method": "post",
136 - "href": "/ledger/credit-account-acquiring/v1/501/authorizations/123/captures/852/credits"
147 + "rel" : "sign-application",
148 + "href" : "/ledger/credit-account-onboardings/v1/501/offers/kontotyp-10000/applications/1561561-54641515-56456/sign-agreement",
149 + "action" : "post"
137 137   }
138 138   ]
139 139  }
... ... @@ -144,18 +144,24 @@
144 144  (% class="table-bordered table-striped" %)
145 145  |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
146 146  |(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
147 -|(% style="width:215px" %)description|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
148 -|(% style="width:215px" %)sellerCaptureTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
149 -|(% style="width:215px" %)pspTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
150 -|(% style="width:215px" %)settlementBatchId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
151 -|(% style="width:215px" %)sellerReceiptId|(% style="width:114px" %)date|(% style="width:118px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:586px" %)
152 -|(% style="width:215px" %)captureAmount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
153 -|(% style="width:215px" %)currency|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
154 -|(% style="width:215px" %)credits|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
160 +|(% style="width:215px" %)nationalConsumerIdentifier.value|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
161 +|(% style="width:215px" %)nationalConsumerIdentifier.countryCode|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
162 +|(% style="width:215px" %)status|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
163 +|(% style="width:215px" %)customerNo|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
164 +|(% style="width:215px" %)emailAddress|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
165 +|(% style="width:215px" %)cellPhone|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
166 +|(% style="width:215px" %)ipAddress|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
167 +|(% style="width:215px" %)LegalAddress.name|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
168 +|(% style="width:215px" %)LegalAddress.streetAddress|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
169 +|(% style="width:215px" %)LegalAddress.city|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
170 +|(% style="width:215px" %)LegalAddress.coAddress|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
171 +|(% style="width:215px" %)LegalAddress.zipCode|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
172 +|(% style="width:215px" %)LegalAddress.countryCode|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength:|(% style="width:586px" %)
173 +|(% style="width:215px" %)account|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)Reference to created account
155 155  
156 -== Credits ==
175 +== Sign-agreement (Operation) ==
157 157  
158 -==== List ====
177 +==== Request ====
159 159  
160 160  {{code language="http" title="**Request**"}}
161 161  GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/credits HTTP/1.1
... ... @@ -165,114 +165,31 @@
165 165  
166 166  {{/code}}
167 167  
168 -==== Get ====
187 +==== Response ====
169 169  
170 170  {{code language="http" title="**Request**"}}
171 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/credits/NNN HTTP/1.1
172 -Host: -
173 -Authorization: Bearer <Token>
190 +HTTP/1.1 201 Created
174 174  Content-Type: application/json
175 175  
176 -{{/code}}
177 -
178 -==== Post ====
179 -
180 -{{code language="http" title="**Request**"}}
181 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/credits HTTP/1.1
182 -Host: -
183 -Authorization: Bearer <Token>
184 -Content-Type: application/json
185 -
186 186  {
187 - "settlementBatchId" : "",
188 - "sellerReversalTransactionId" : "534313",
189 - "amountInclVat": 200.0,
190 - "currency": "SEK",
194 + "createdAccount" : "https://api.payex.com/ledger/credit-account/v1/123/accounts/123456",
191 191  }
192 192  {{/code}}
193 193  
194 -==== Resource ====
198 +==== ====
195 195  
196 -{{code language="http" title="**Response**"}}
197 -HTTP/1.1 200 OK
198 -Content-Type: application/json
199 -
200 -{
201 - "settlementBatchId" : "",
202 - "sellerReversalTransactionId" : "534313",
203 - "amountInclVat": 200.0,
204 - "creditedAmountInclVat": 200.0,
205 - "currency": "SEK",
206 - "@id" : "/ledger/credit-account-acquiring/v1/501/authorizations/123/captures/852/credits/741",
207 - "parentHREF": "/ledger/credit-account-acquiring/v1/501/authorizations/123/captures/852",
208 - "operations" : []
209 -}
210 -{{/code}}
211 -
212 212  **Resource properties**
213 213  
214 214  (% class="table-bordered table-striped" %)
215 215  |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
216 -|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
217 -|(% style="width:215px" %)settlementBatchId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
218 -|(% style="width:215px" %)sellerReversalTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength|(% style="width:586px" %)
219 -|(% style="width:215px" %)amountInclVat|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
220 -|(% style="width:215px" %)creditedAmountInclVat|(% style="width:114px" %)decimal|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
221 -|(% style="width:215px" %)currency|(% style="width:114px" %)date|(% style="width:118px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:586px" %)
204 +|(% style="width:215px" %)createdAccount|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)
222 222  
223 -== Cancellations ==
206 +(% class="wikigeneratedid" %)
207 +== ==
224 224  
225 -==== List ====
209 +(% class="wikigeneratedid" %)
210 +== Problems ==
226 226  
227 -{{code language="http" title="**Request**"}}
228 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/cancellations HTTP/1.1
229 -Host: -
230 -Authorization: Bearer <Token>
231 -Content-Type: application/json
232 -
233 -{{/code}}
234 -
235 -==== Get ====
236 -
237 -{{code language="http" title="**Request**"}}
238 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/cancellations/NNN HTTP/1.1
239 -Host: -
240 -Authorization: Bearer <Token>
241 -Content-Type: application/json
242 -
243 -{{/code}}
244 -
245 -==== Post ====
246 -
247 -{{code language="http" title="**Request**"}}
248 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/captures/YYY/cancellations HTTP/1.1
249 -Host: -
250 -Authorization: Bearer <Token>
251 -Content-Type: application/json
252 -{{/code}}
253 -
254 -==== Resource ====
255 -
256 -{{code language="http" title="**Response**"}}
257 -HTTP/1.1 200 OK
258 -Content-Type: application/json
259 -
260 -{
261 - "cancellationDate" : "2019-11-20",
262 - "@id" : "/ledger/credit-account-acquiring/v1/501/authorizations/123/cancellations",
263 - "parentHREF" : "/ledger/credit-account-acquiring/v1/501/authorizations/123"
264 -}
265 -{{/code}}
266 -
267 -**Resource properties**
268 -
269 -(% class="table-bordered table-striped" %)
270 -|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
271 -|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
272 -|(% style="width:215px" %)cancellationDate|(% style="width:114px" %)date|(% style="width:118px" %) |(% style="width:586px" %)
273 -
274 -Problems
275 -
276 276  If an error occur or any validation failed, a "problem" response will be returned.
277 277  Below is a list of problems that can occur:
278 278