Changes for page card-transaction
Last modified by David Persson on 2024/02/21 07:48
From empty
To version 37.1
edited by David Persson
on 2020/03/02 15:26
on 2020/03/02 15:26
Change comment: There is no comment for this version
Summary
-
Page properties (6 modified, 0 added, 0 removed)
-
Attachments (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +../card-transaction - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Main.credit-account.api.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 - XWiki.XWikiGuest1 +xwiki:XWiki.dap - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +px-custom-page-content - Content
-
... ... @@ -1,0 +1,715 @@ 1 +(% class="jumbotron" %) 2 +((( 3 +(% class="container" %) 4 +((( 5 + 6 + 7 +Integrate to **PayEx Ledger Card transaction API ** 8 +))) 9 +))) 10 + 11 +(% class="lead" %) 12 +The card transaction api contains functions that are used in payment scenarios: online, in-store and offline. Before transactions can be created an account must exists with associated cards. 13 + 14 +[[image:1582269692453-459.png||height="344" width="459"]] 15 + 16 +---- 17 + 18 += Changelog = 19 + 20 + 21 +== Authorizations == 22 + 23 +(% class="wikigeneratedid" %) 24 +An authorization is done as the first step in using an account as payment. A successful authorization leads to a reservation on the account, the account is identified through the **cardToken.** The authorization is not a financial transaction, to make the financial transaction a Purchase (or other type of transaction) must be posted on the authorization. 25 + 26 +==== Post authorizations ==== 27 + 28 +{{code language="http" title="**Request**"}} 29 +POST /ledger/card-transaction/v1/XXX/authorizations HTTP/1.1 30 +Host: - 31 +Authorization: Bearer <Token> 32 +Content-Type: application/json 33 + 34 +{ 35 + "sourceAuthorizationTransactionId": "789", 36 + "sellerNumber": "654", 37 + "cardToken": "5646735165", 38 + "type": "Purchase|Reversal|CashWithdrawal", 39 + "pointOfSale": "Testshop", 40 + "authorizationAmount": 300.0, 41 + "currency": "SEK" 42 +} 43 +{{/code}} 44 + 45 + 46 +{{code language="http" title="**Response**"}} 47 +HTTP/1.1 201 CREATED 48 +Content-Type: application/json 49 + 50 +{ 51 + "authorizationId": "YYY", 52 + "@id": "/ledger/card-transaction/v1/XXX/authorizations/YYY", 53 + "parentHREF": "/", 54 + "operations": [] 55 +} 56 +{{/code}} 57 + 58 +==== 59 +Get authorizations ==== 60 + 61 +{{code language="http" title="**Request**"}} 62 +GET /ledger/card-transaction/v1/XXX/authorizations/YYY HTTP/1.1 63 +Host: - 64 +Authorization: Bearer <Token> 65 +Content-Type: application/json 66 +{{/code}} 67 + 68 +==== ==== 69 + 70 +{{code language="http" title="**Response**"}} 71 +HTTP/1.1 200 OK 72 +Content-Type: application/json 73 + 74 +{ 75 + "sourceAuthorizationTransactionId": "789", 76 + "authorizationId": 123, 77 + "sellerNumber": "654", 78 + "cardToken": "546415646315", 79 + "type": "Purchase|Reversal|CashWithdrawal", 80 + "pointOfSale": "Testshop", 81 + "validToDate": "2019-11-28", 82 + "authorizationAmount": 300.0, 83 + "remainingAmount" : 150.0, 84 + "currency": "SEK", 85 + "@id": "/ledger/card-transaction/v1/XXX/authorizations/NNN", 86 + "purchases": "/ledger/card-transaction/v1/XXX/purchases?authorizationId=123", 87 + "cash-withdrawals": "/ledger/card-transaction/v1/XXX/cash-withdrawals?authorizationId=123", 88 + "reversals": "/ledger/card-transaction/v1/XXX/reversals?authorizationId=123", 89 + "parentHREF": "/", 90 + "operations": [] 91 +} 92 +{{/code}} 93 + 94 + 95 +==== Resource properties authorizations ==== 96 + 97 +(% class="table-bordered table-striped" %) 98 +|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description 99 +|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Uri |(% style="width:586px" %) 100 +|(% style="width:215px" %)sourceAuthorizationTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %)Unique identifier of the specific authorization, generated by source (typically the integrating system) 101 +|(% style="width:215px" %)authorizationId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 6|(% style="width:586px" %)Unique identifier of the authorization, generated by PayEx. Should be stored and must be set when transactions is to be created (except for purchases in offline mode) 102 +|(% style="width:215px" %)sellerNumber|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 15|(% style="width:586px" %)Identifier of the current seller/merchant 103 +|(% style="width:215px" %)cardToken|(% style="width:114px" %)string|(% style="width:118px" %) |(% style="width:586px" %)Identifier of the card. The aurhotization is made on the account that the card is linked to 104 +|(% style="width:215px" %)type|(% style="width:114px" %)string|(% style="width:118px" %) |(% style="width:586px" %)((( 105 +type of authorization 106 + 107 +* Purchase 108 +* Reversal 109 +* CashWithdrawal 110 +))) 111 +|(% style="width:215px" %)pointOfSale|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %)Name of the location/point/shop of sale, will be returned in reservation resource 112 +|(% 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" %)Purchase can not be executed after this date 113 +|(% style="width:215px" %)authorizeAmount|(% style="width:114px" %)decimal|(% style="width:118px" %)Amount|(% style="width:586px" %)Original authorized amount 114 +|(% style="width:215px" %)remainingAmount|(% style="width:114px" %)decimal|(% style="width:118px" %)Amount|(% style="width:586px" %)Amount left on the authorization that can be Purchased 115 +|(% style="width:215px" %)currency|(% style="width:114px" %)string|(% style="width:118px" %)[[ISO 4217>>url:https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:586px" %) 116 +|(% style="width:215px" %)purchases|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %) 117 +|(% style="width:215px" %)cash-withdrawals|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %) 118 +|(% style="width:215px" %)reversals|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %) 119 + 120 +---- 121 + 122 +== Purchases == 123 + 124 +==== Post purchases ==== 125 + 126 +{{code language="http" title="**Request**"}} 127 +POST /ledger/card-transaction/v1/XXX/purchases HTTP/1.1 128 +Host: - 129 +Authorization: Bearer <Token> 130 +Content-Type: application/json 131 + 132 +{ 133 + "authorizationId" : "AUTH71", 134 + "sourcePurchaseTransactionId" : "534313", 135 + "sellerReceiptId": "58743597125", 136 + "additionalReferences":{ 137 + "acquirerBatchId": "200206885010", 138 + "acquirerTransactionId" : "534313" 139 + }, 140 + "amount": 200.0, 141 + "date": "2019-11-28", 142 + "offlineInfo" : { 143 + "pointOfSale": "Testshop", 144 + "cardToken": "5646735165", 145 + "sellerNumber": "654", 146 + "currency": "SEK", 147 + } 148 +} 149 +{{/code}} 150 + 151 +==== Get purchases ==== 152 + 153 +{{code language="http" title="**Request**"}} 154 +GET /ledger/card-transaction/v1/XXX/purchases/YYY HTTP/1.1 155 +Host: - 156 +Authorization: Bearer <Token> 157 +Content-Type: application/json 158 + 159 +{{/code}} 160 + 161 +==== List purchases ==== 162 + 163 +{{code language="http" title="**Request**"}} 164 +GET /ledger/card-transaction/v1/XXX/purchases HTTP/1.1 165 +Host: - 166 +Authorization: Bearer <Token> 167 +Content-Type: application/json 168 + 169 +{{/code}} 170 + 171 +==== Resource purchases ==== 172 + 173 +{{code language="http" title="**Response**"}} 174 +HTTP/1.1 201 CREATED 175 +Content-Type: application/json 176 + 177 +{ 178 + "description": "stora butiken test, köpref. 12345689", 179 + "authorizationId" : "AUTH71", 180 + "sourcePurchaseTransactionId" : "534313", 181 + "sellerReceiptId": "58743597125", 182 + "additionalReferences":{ 183 + "acquirerBatchId": "200206885010", 184 + "acquirerTransactionId" : "534313" 185 + }, 186 + "amount": 200.0, 187 + "date": "2019-11-28", 188 + "offlineInfo" : { 189 + "pointOfSale": "Testshop", 190 + "cardToken": "5646735165", 191 + "sellerNumber": "654", 192 + "currency": "SEK", 193 + }, 194 + "corrections": "/ledger/card-transaction/v1/XXX/purchases/YYY/corrections", 195 + "@id": "/ledger/card-transaction/v1/XXX/purchases/YYY", 196 + "operations": [ 197 + { 198 + "rel": "create-correction", 199 + "method": "post", 200 + "href": "/ledger/card-transaction/v1/XXX/authorizations/NNN/purchases/YYY/corrections" 201 + } 202 + ] 203 +} 204 +{{/code}} 205 + 206 +==== Resource properties purchases ==== 207 + 208 +(% class="table-bordered table-striped" %) 209 +|=(% style="width: 337px;" %)Property|=(% style="width: 121px;" %)Data type|=(% style="width: 164px;" %)Format|=(% style="width: 1156px;" %)Description 210 +|(% style="width:337px" %)@id |(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %) 211 +|(% style="width:337px" %)description|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 200|(% style="width:1156px" %)Describes the current Purchase (derives from info sent in the authorization), may be printed on the bill, output only 212 +|(% style="width:337px" %)authorizationId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 6|(% style="width:1156px" %)The id of the authorization from which this purchase originated from (not required if the purchase was made offline) 213 +|(% style="width:337px" %)((( 214 +(% style="background-color:transparent" %)sourcePurchaseTransactionId 215 +)))|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique identifier of the Purchase transaction 216 +|(% style="width:337px" %)((( 217 +additionalReferences.acquirerBatchId 218 +)))|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Used for reconciling acquirer transactions. See [[RKHA21>>||anchor="HRKHA21format"]] section on this page for more information 219 +|(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction 220 +|(% style="width:337px" %)sellerReceiptId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %) 221 +|(% style="width:337px" %)amount|(% style="width:121px" %)decimal|(% style="width:164px" %) |(% style="width:1156px" %) 222 +|(% style="width:337px" %)date|(% style="width:121px" %)date|(% style="width:164px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1156px" %)valuedate of the transaction 223 +|(% style="width:337px" %)offlineInfo.pointOfSale|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Name of the location/point/shop of sale, will be returned in reservation resource 224 +|(% style="width:337px" %)offlineInfo.cardToken|(% style="width:121px" %)string|(% style="width:164px" %) |(% style="width:1156px" %)Identifier of the card. The purchase will be made on the account that the card is linked to 225 +|(% style="width:337px" %)offlineInfo.sellerNumber|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 15|(% style="width:1156px" %)Identifier of the current seller/merchant 226 +|(% style="width:337px" %)corrections|(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %) 227 + 228 +---- 229 + 230 +== Cash-withdrawals == 231 + 232 +==== Post cash-withdrawals ==== 233 + 234 +{{code language="http" title="**Request**"}} 235 +POST /ledger/card-transaction/v1/XXX/cash-withdrawals HTTP/1.1 236 +Host: - 237 +Authorization: Bearer <Token> 238 +Content-Type: application/json 239 + 240 +{ 241 + "authorizationId" : "AUTH71", 242 + "sourceCashWithdrawalTransactionId" : "534313", 243 + "sellerReceiptId": "54313546", 244 + "additionalReferences":{ 245 + "acquirerBatchId": "fdsfsdfsd", 246 + "acquirerTransactionId" : "534313" 247 + }, 248 + "amount": 200.0, 249 + "date": "2019-11-28" 250 +} 251 +{{/code}} 252 + 253 +==== Get cash-withdrawals ==== 254 + 255 +{{code language="http" title="**Request**"}} 256 +GET /ledger/card-transaction/v1/XXX/cash-withdrawals/YYY HTTP/1.1 257 +Host: - 258 +Authorization: Bearer <Token> 259 +Content-Type: application/json 260 + 261 +{{/code}} 262 + 263 +==== List cash-withdrawals ==== 264 + 265 +{{code language="http" title="**Request**"}} 266 +GET /ledger/card-transaction/v1/XXX/cash-withdrawals HTTP/1.1 267 +Host: - 268 +Authorization: Bearer <Token> 269 +Content-Type: application/json 270 + 271 +{{/code}} 272 + 273 +==== Resource cash-withdrawals ==== 274 + 275 +{{code language="http" title="**Response**"}} 276 +HTTP/1.1 201 CREATED 277 +Content-Type: application/json 278 + 279 +{ 280 + "description": "stora butiken test, köpref. 12345689", 281 + "authorizationId" : "AUTH71", 282 + "sourceCashWithdrawalTransactionId" : "534313", 283 + "sellerReceiptId": "541687421", 284 + "additionalReferences":{ 285 + "acquirerBatchId": "200206885020", 286 + "acquirerTransactionId" : "534313" 287 + }, 288 + "amount": 200.0, 289 + "date": "2019-11-28", 290 + "corrections": "/ledger/card-transaction/v1/XXX/cash-withdrawals/YYY/corrections", 291 + "@id": "/ledger/card-transaction/v1/XXX/cash-withdrawals/YYY", 292 + "operations": [ 293 + { 294 + "rel": "create-correction", 295 + "method": "post", 296 + "href": "/ledger/card-transaction/v1/XXX/cash-withdrawals/YYY/corrections" 297 + } 298 + ] 299 +} 300 +{{/code}} 301 + 302 +==== Resource properties cash-withdrawals ==== 303 + 304 +(% class="table-bordered table-striped" %) 305 +|=(% style="width: 337px;" %)Property|=(% style="width: 121px;" %)Data type|=(% style="width: 164px;" %)Format|=(% style="width: 1156px;" %)Description 306 +|(% style="width:337px" %)@id |(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %) 307 +|(% style="width:337px" %)description|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 200|(% style="width:1156px" %)Describes the current cash-withdrawals (derives from info sent in the authorization), may be printed on the bill, output only 308 +|(% style="width:337px" %)authorizationId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 6|(% style="width:1156px" %)The id of the authorization from which this cash-withdrawal transaction originated from 309 +|(% style="width:337px" %)((( 310 +(% style="background-color:transparent" %)sourceCashWithdrawalTransactionId 311 +)))|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique identifier of the cash-withdrawal transaction 312 +|(% style="width:337px" %)((( 313 +additionalReferences.acquirerBatchId 314 +)))|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Used for reconciling acquirer transactions. See [[RKHA21>>||anchor="HRKHA21format"]] section on this page for more information 315 +|(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction 316 +|(% style="width:337px" %)sellerReceiptId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %) 317 +|(% style="width:337px" %)amount|(% style="width:121px" %)decimal|(% style="width:164px" %) |(% style="width:1156px" %) 318 +|(% style="width:337px" %)date|(% style="width:121px" %)date|(% style="width:164px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1156px" %)valuedate of the transaction 319 +|(% style="width:337px" %)corrections|(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %) 320 + 321 +---- 322 + 323 +=== Reversals === 324 + 325 +Used to refund a purchase for any reason 326 + 327 +==== Create reversals ==== 328 + 329 +Execute post towards this resource to add the amount on the card (account) specified in the authorization 330 + 331 +{{code language="http" title="**Request**"}} 332 +POST /ledger/card-transaction/v1/XXX/reversals HTTP/1.1 333 +Host: - 334 +Authorization: Bearer <Token> 335 +Content-Type: application/json 336 + 337 +{ 338 + "authorizationId" : "AUTH71", 339 + "sellerReceiptId": "12345689", 340 + "additionalReferences":{ 341 + "acquirerBatchId": "200206885020", 342 + "acquirerTransactionId" : "534313", 343 + }, 344 + "sourceReversalTransactionId" : "534312", 345 + "amount": 200.0, 346 + "date": "2019-11-28" 347 +} 348 +{{/code}} 349 + 350 +==== Get reversals ==== 351 + 352 +{{code language="http" title="**Request**"}} 353 +GET /ledger/card-transaction/v1/XXX/reversals/YYY HTTP/1.1 354 +Host: - 355 +Authorization: Bearer <Token> 356 +Content-Type: application/json 357 + 358 +{{/code}} 359 + 360 +==== List reversals ==== 361 + 362 +{{code language="http" title="**Request**"}} 363 +GET /ledger/card-transaction/v1/XXX/reversals HTTP/1.1 364 +Host: - 365 +Authorization: Bearer <Token> 366 +Content-Type: application/json 367 + 368 +{{/code}} 369 + 370 +==== Resource reversals ==== 371 + 372 +{{code language="http" title="**Response**"}} 373 +HTTP/1.1 200 OK 374 +Content-Type: application/json 375 + 376 +{ 377 + "authorizationId" : "AUTH71", 378 + "sellerReceiptId": "12345689", 379 + "additionalReferences":{ 380 + "acquirerBatchId": "200206885020", 381 + "acquirerTransactionId" : "534313", 382 + }, 383 + "sourceReversalTransactionId" : "534312", 384 + "amount": 200.0, 385 + "date": "2019-11-28", 386 + "@id" : "/ledger/card-transaction/v1/XXX/reversals/YYY", 387 + "operations" : [ 388 + { 389 + "rel": "create-correction", 390 + "method": "post", 391 + "href": "/ledger/card-transaction/v1/XXX/reversals/YYY/corrections" 392 + } 393 + ] 394 +} 395 +{{/code}} 396 + 397 +==== Resource reversals properties ==== 398 + 399 +(% class="table-bordered table-striped" %) 400 +|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description 401 +|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %) 402 +|(% style="width:337px" %)authorizationId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 6|(% style="width:1156px" %)The id of the authorization from which this reversal originated from 403 +|(% style="width:337px" %)sellerReceiptId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %) 404 +|(% style="width:337px" %)((( 405 +additionalReferences.acquirerBatchId 406 +)))|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Used for reconciling acquirer transactions. See [[RKHA21>>||anchor="HRKHA21format"]] section on this page for more information 407 +|(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction 408 +|(% style="width:215px" %)sourceReversalTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %) 409 +|(% style="width:215px" %)amount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %) 410 +|(% style="width:337px" %)date|(% style="width:121px" %)date|(% style="width:164px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1156px" %)valuedate of the transaction 411 + 412 +=== Corrections === 413 + 414 +Each type of transactions can be corrected by making a POST call against its correction resource 415 + 416 +==== Create purchase corrections ==== 417 + 418 +{{code language="http" title="**Request**"}} 419 +POST /ledger/card-transaction/v1/XXX/purchases/YYY/corrections HTTP/1.1 420 +Host: - 421 +Authorization: Bearer <Token> 422 +Content-Type: application/json 423 + 424 +{ 425 + "additionalReferences":{ 426 + "acquirerBatchId": "200206885020", 427 + "acquirerTransactionId" : "534313", 428 + }, 429 + "sourceCorrectionTransactionId" : "534313", 430 + "amount": 200.0, 431 + "date": "2019-11-28" 432 +} 433 +{{/code}} 434 + 435 +==== Create cash-withdrawal corrections ==== 436 + 437 +{{code language="http" title="**Request**"}} 438 +POST /ledger/card-transaction/v1/XXX/cash-withdrawal/YYY/corrections HTTP/1.1 439 +Host: - 440 +Authorization: Bearer <Token> 441 +Content-Type: application/json 442 + 443 +{ 444 + "additionalReferences":{ 445 + "acquirerBatchId": "200206885020", 446 + "acquirerTransactionId" : "534313", 447 + }, 448 + "sourceCorrectionTransactionId" : "534313", 449 + "amount": 200.0, 450 + "date": "2019-11-28" 451 +} 452 +{{/code}} 453 + 454 +==== Create reversal corrections ==== 455 + 456 +{{code language="http" title="**Request**"}} 457 +POST /ledger/card-transaction/v1/XXX/reversals/YYY/corrections HTTP/1.1 458 +Host: - 459 +Authorization: Bearer <Token> 460 +Content-Type: application/json 461 + 462 +{ 463 + "additionalReferences":{ 464 + "acquirerBatchId": "200206885020", 465 + "acquirerTransactionId" : "534313", 466 + }, 467 + "sourceCorrectionTransactionId" : "534313", 468 + "amount": 200.0, 469 + "date": "2019-11-28" 470 +} 471 +{{/code}} 472 + 473 +==== Corrections resource properties ==== 474 + 475 +(% class="table-bordered table-striped" %) 476 +|=(% style="width: 215px;" %)((( 477 +Property 478 +)))|=(% style="width: 114px;" %)((( 479 +Data type 480 +)))|=(% style="width: 118px;" %)((( 481 +Format 482 +)))|=(% style="width: 586px;" %)((( 483 +Description 484 +))) 485 +|(% style="width:215px" %)((( 486 +@id 487 +)))|(% style="width:114px" %)((( 488 +string 489 +)))|(% style="width:118px" %)((( 490 +Maxlength: 491 +)))|(% style="width:586px" %)((( 492 + 493 +))) 494 +|(% style="width:337px" %)((( 495 +additionalReferences.acquirerBatchId 496 +)))|(% style="width:121px" %)((( 497 +string 498 +)))|(% style="width:164px" %)((( 499 +Maxlength: 50 500 +)))|(% style="width:1156px" %)((( 501 +Used for reconciling acquirer transactions. See [[RKHA21>>||anchor="HRKHA21format"]] section on this page for more information 502 +))) 503 +|(% style="width:337px" %)((( 504 +additionalReferences.acquirerTransactionId 505 +)))|(% style="width:121px" %)((( 506 +string 507 +)))|(% style="width:164px" %)((( 508 +Maxlength: 50 509 +)))|(% style="width:1156px" %)((( 510 +Unique acquirer identifier of the transaction 511 +))) 512 +|(% style="width:215px" %)((( 513 +sourceCorrectionTransactionId 514 +)))|(% style="width:114px" %)((( 515 +string 516 +)))|(% style="width:118px" %)((( 517 +Maxlength: 50 518 +)))|(% style="width:586px" %)((( 519 + 520 +))) 521 +|(% style="width:215px" %)((( 522 +amount 523 +)))|(% style="width:114px" %)((( 524 +decimal 525 +)))|(% style="width:118px" %)((( 526 + 527 +)))|(% style="width:586px" %)((( 528 + 529 +))) 530 +|(% style="width:337px" %)date|(% style="width:121px" %)date|(% style="width:164px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1156px" %)valuedate of the transaction 531 + 532 +== RKHA21 format == 533 + 534 +If the original source for the transactions towards purchases/cash-withdrawals/reversals/corrections is the RKHA21 file the below rules should be used to set the AcquirerBatchId. 535 + 536 +AcquirerBatchId = [Processing date][Sender][Cycle] 537 + 538 +For the example values in the table below the AcquirerBatchId will be "**200206885020**". 539 + 540 +**RKHA21 file header row description** 541 + 542 +(% class="table-bordered table-striped" %) 543 +|=(% style="width: 113px;" %)((( 544 +Position 545 +)))|=(% style="width: 226px;" %)((( 546 +Field 547 +)))|=(% style="width: 118px;" %)((( 548 +Format 549 +)))|=(% style="width: 586px;" %)((( 550 +Description 551 +)))|=(% style="width: 586px;" %)((( 552 +Example 553 +))) 554 +|(% style="width:113px" %)((( 555 +1 556 +)))|(% style="width:226px" %)((( 557 +Transaction code 558 +)))|(% style="width:118px" %)((( 559 +2 N 560 +)))|(% style="width:586px" %)((( 561 +01 562 +)))|(% style="width:586px" %)((( 563 + 564 +))) 565 +|(% style="width:113px" %)((( 566 +3 567 +)))|(% style="width:226px" %)((( 568 +Processing date 569 +)))|(% style="width:118px" %)((( 570 +6 N 571 +)))|(% style="width:586px" %)((( 572 +YYMMDD 573 +)))|(% style="width:586px" %)((( 574 +200206 575 +))) 576 +|(% style="width:113px" %)((( 577 +9 578 +)))|(% style="width:226px" %)((( 579 +Sender 580 +)))|(% style="width:118px" %)((( 581 +4 N 582 +)))|(% style="width:586px" %)((( 583 +"8850" (Babs) 584 +)))|(% style="width:586px" %)((( 585 +8850 586 +))) 587 +|(% style="width:113px" %)((( 588 +13 589 +)))|(% style="width:226px" %)((( 590 +Cycle 591 +)))|(% style="width:118px" %)((( 592 +2 AN 593 +)))|(% style="width:586px" %)((( 594 +10/20 595 +)))|(% style="width:586px" %)((( 596 +20 597 +))) 598 +|(% style="width:113px" %)((( 599 +15 600 +)))|(% style="width:226px" %)((( 601 +Filler 602 +)))|(% style="width:118px" %)((( 603 +26 AN 604 +)))|(% style="width:586px" %)((( 605 +Space characters 606 +)))|(% style="width:586px" %)((( 607 + 608 +))) 609 +|(% style="width:113px" %)((( 610 +41 611 +)))|(% style="width:226px" %)((( 612 +Vers.nr/serial number 613 +)))|(% style="width:118px" %)((( 614 +6 N 615 +)))|(% style="width:586px" %)((( 616 +File serial number 617 +)))|(% style="width:586px" %)((( 618 + 619 +))) 620 +|(% style="width:113px" %)((( 621 +47 622 +)))|(% style="width:226px" %)((( 623 +Transaction entry 624 +)))|(% style="width:118px" %)((( 625 +1 AN 626 +)))|(% style="width:586px" %)((( 627 + 628 +)))|(% style="width:586px" %)((( 629 + 630 +))) 631 +|(% style="width:113px" %)((( 632 +48 633 +)))|(% style="width:226px" %)((( 634 +Filler 635 +)))|(% style="width:118px" %)((( 636 +333 AN 637 +)))|(% style="width:586px" %)((( 638 +Space characters 639 +)))|(% style="width:586px" %)((( 640 + 641 +))) 642 + 643 +(% class="box successmessage" %) 644 +((( 645 +The **rkha **format actually has a 28 character filler at position 13 by default, but for "Babs" the first two positions in this filler are redefined to be "cycle" (position 13 and 14), which leaves the Filler to be 26 characters instead of 28. 646 +))) 647 + 648 +== Problems == 649 + 650 +If an error occur or any validation failed, a "problem" response will be returned. 651 +Below is a list of problems that can occur: 652 + 653 +**HttpStatus 401 Unauthorized** 654 + 655 +((( 656 +* Token expired 657 +* Token invalid 658 +* CompanyNumber does not match token 659 +))) 660 + 661 +**HttpStatus 400 Error** 662 + 663 +((( 664 +* Validation: Argument required 665 +* Validation: Invalid value 666 +))) 667 + 668 +**HttpStatus 409 Conflict** 669 + 670 +((( 671 +* Authorization declined 672 +* Card with token {cardtoken} does not exists 673 +* Duplicate authorization 674 +* Duplicate purchase 675 +* Duplicate cash-withdrawal 676 +* Duplicate reversal 677 +* Duplicate correction 678 +* Authorization has expired 679 +* Insufficient amount to correct 680 +* Insufficient amount on authorization 681 +))) 682 + 683 +**HttpStatus 501 NotImplemented** 684 + 685 +((( 686 +* CompanyNumber XXX not configured 687 +* SellerNumber XXX not configured at PayEx 688 +* CompanyNumber XXX missing configuration 689 +))) 690 + 691 +**HttpStatus 404 NotFound** 692 + 693 +* ((( 694 +Authorization not found 695 +))) 696 + 697 +Below is an example of a problem that will be returned if acquirerBatchId is not valid. 698 + 699 +{{code language="http" title="**Response**"}} 700 +HTTP/1.1 400 Error 701 +Content-Type: application/problem+json 702 + 703 +{ 704 + "Type": "http://[DNS]/ledger/card-transaction/problems/validation", 705 + "Title": "A validation error occurred", 706 + "Status": 400, 707 + "Instance": null, 708 + "Detail": "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.", 709 + "Problems": [ 710 + { 711 + "additionalReferences.acquirerBatchId": "Not a valid acquirerBatchId" 712 + } 713 + ] 714 +} 715 +{{/code}}
- 1582184597141-697.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1582269692453-459.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content