Changes for page card-transaction
Last modified by David Persson on 2024/02/21 07:48
From version 3.1
edited by David Persson
on 2020/02/19 22:00
on 2020/02/19 22:00
To version 4.1
edited by David Persson
on 2020/02/19 22:07
on 2020/02/19 22:07
Change comment: There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -22,7 +22,7 @@ 22 22 sellerReversalTransactionId -> sourceReversalTransactionId 23 23 24 24 2020-01-30 25 -Added "re funds" resource to use when reversal is made with card and the original capture cannot be referenced.25 +Added "reversals" resource to use when reversal is made with card and the original capture cannot be referenced. 26 26 27 27 (% class="wikigeneratedid" %) 28 28 2020-01-30 ... ... @@ -45,7 +45,7 @@ 45 45 "sourceAuthorizationTransactionId": "789", 46 46 "sellerNumber": "654", 47 47 "cardToken": "5646735165", 48 - " accountNo":null,48 + "type": "purchase|reversal|cash-withdrawal", 49 49 "pointOfSale": "Testshop", 50 50 "authorizationAmount": 300.0, 51 51 "currency": "SEK" ... ... @@ -54,10 +54,7 @@ 54 54 55 55 (% class="box successmessage" %) 56 56 ((( 57 -**Note: **Either "card" or "accountNo" must be specified in the post request (not both). 58 - 59 -The above example shows an authorization done with a card. All cards are linked to an account, to which the authorization will also be linked. 60 -If an authorization is to be made directly against the account, the parameter "accountNo" should be specified in the post body, instead of "cardToken". 57 + 61 61 ))) 62 62 63 63 {{code language="http" title="**Response**"}} ... ... @@ -97,7 +97,7 @@ 97 97 "remainingAmount" : 150.0, 98 98 "currency": "SEK", 99 99 "@id": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN", 100 - " captures": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/captures",97 + "purchases": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases", 101 101 "cancellations": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/cancellations", 102 102 "schemaUri": "/ledger/invoice-purchase/v1/PayEx.AR.InvoicePurchase.Api.Resources.Authorizations.Resource", 103 103 "parentHREF": "/", ... ... @@ -105,7 +105,7 @@ 105 105 { 106 106 "rel": "create-capture", 107 107 "method": "post", 108 - "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures"105 + "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases" 109 109 }, 110 110 { 111 111 "rel": "create-cancellation", ... ... @@ -132,17 +132,17 @@ 132 132 |(% style="width:215px" %)authorizeAmount|(% style="width:114px" %)decimal|(% style="width:118px" %)Amount|(% style="width:586px" %)Original authorized amount 133 133 |(% style="width:215px" %)remainingAmount|(% style="width:114px" %)decimal|(% style="width:118px" %)Amount|(% style="width:586px" %)Amount left on the authorization that can be captured 134 134 |(% style="width:215px" %)currency|(% style="width:114px" %)string|(% style="width:118px" %)[[ISO 4217>>url:https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:586px" %) 135 -|(% style="width:215px" %) captures|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %)132 +|(% style="width:215px" %)purchases|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %) 136 136 |(% style="width:215px" %)cancellations|(% style="width:114px" %)string|(% style="width:118px" %)Uri|(% style="width:586px" %) 137 137 138 138 ---- 139 139 140 -== Captures ==137 +== Purchases == 141 141 142 -==== Post captures ====139 +==== Post purchases ==== 143 143 144 144 {{code language="http" title="**Request**"}} 145 -POST /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures HTTP/1.1142 +POST /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases HTTP/1.1 146 146 Host: - 147 147 Authorization: Bearer <Token> 148 148 Content-Type: application/json ... ... @@ -158,10 +158,10 @@ 158 158 } 159 159 {{/code}} 160 160 161 -==== Get captures ====158 +==== Get purchases ==== 162 162 163 163 {{code language="http" title="**Request**"}} 164 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY HTTP/1.1161 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY HTTP/1.1 165 165 Host: - 166 166 Authorization: Bearer <Token> 167 167 Content-Type: application/json ... ... @@ -168,10 +168,10 @@ 168 168 169 169 {{/code}} 170 170 171 -==== List captures ====168 +==== List purchases ==== 172 172 173 173 {{code language="http" title="**Request**"}} 174 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures HTTP/1.1171 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases HTTP/1.1 175 175 Host: - 176 176 Authorization: Bearer <Token> 177 177 Content-Type: application/json ... ... @@ -178,7 +178,7 @@ 178 178 179 179 {{/code}} 180 180 181 -==== Resource captures ====178 +==== Resource purchases ==== 182 182 183 183 {{code language="http" title="**Response**"}} 184 184 HTTP/1.1 201 CREATED ... ... @@ -193,7 +193,7 @@ 193 193 }, 194 194 "sellerReceiptId": "12345689", 195 195 "amount": 200.0, 196 - "r eversals": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/captures/YYY/reversals",193 + "corrections": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections", 197 197 "@id": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/capture/YYY", 198 198 "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN", 199 199 "operations": [ ... ... @@ -200,13 +200,13 @@ 200 200 { 201 201 "rel": "create-reversal", 202 202 "method": "post", 203 - "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/reversal"200 + "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/reversal" 204 204 } 205 205 ] 206 206 } 207 207 {{/code}} 208 208 209 -==== Resource properties captures ====206 +==== Resource properties purchases ==== 210 210 211 211 (% class="table-bordered table-striped" %) 212 212 |=(% style="width: 337px;" %)Property|=(% style="width: 121px;" %)Data type|=(% style="width: 164px;" %)Format|=(% style="width: 1156px;" %)Description ... ... @@ -221,13 +221,13 @@ 221 221 |(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction 222 222 |(% style="width:337px" %)sellerReceiptId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %) 223 223 |(% style="width:337px" %)amount|(% style="width:121px" %)decimal|(% style="width:164px" %) |(% style="width:1156px" %) 224 -|(% style="width:337px" %)r eversals|(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %)221 +|(% style="width:337px" %)corrections|(% style="width:121px" %)string|(% style="width:164px" %)Uri|(% style="width:1156px" %) 225 225 226 226 ---- 227 227 228 -== Offline- captures ==225 +== Offline-purchases == 229 229 230 -Offline capture transactions can be used when the point of sales cannot connect to the acquiring api to perform standard authorizations. Offline captures can cause the charged credit account to exceed the account limits. Offlinecaptures are always limited by agreement. Different acquiring terms apply for offline-captures compared to standard authorization ->captures.227 +Offline capture transactions can be used when the point of sales cannot connect to the acquiring api to perform standard authorizations. Offline purchases can cause the charged credit account to exceed the account limits. Offline purchases are always limited by agreement. Different acquiring terms apply for offline-purchases compared to standard authorization -> purchases. 231 231 232 232 (% class="box warningmessage" %) 233 233 ((( ... ... @@ -234,10 +234,10 @@ 234 234 **Note!** This is not a general purpose function. The agreement between the client and PayEx will dictate if the function can be used. 235 235 ))) 236 236 237 -==== Post offline- captures ====234 +==== Post offline-purchases ==== 238 238 239 239 {{code language="http" title="**Request**"}} 240 -POST /ledger/credit-account-acquiring/v1/XXX/offline- captures HTTP/1.1237 +POST /ledger/credit-account-acquiring/v1/XXX/offline-purchases HTTP/1.1 241 241 Host: - 242 242 Authorization: Bearer <Token> 243 243 Content-Type: application/json ... ... @@ -255,8 +255,8 @@ 255 255 "accountToken" : null, 256 256 "captureAmount": 300.0, 257 257 "currency": "SEK", 258 - "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY",259 - "credits" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/credits",255 + "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY", 256 + "credits" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/credits", 260 260 "schemaUri": "/ledger/invoice-purchase/v1/PayEx.AR.InvoicePurchase.Api.Resources.Authorizations.Resource", 261 261 "parentHREF": "/", 262 262 "operations" : [] ... ... @@ -266,13 +266,13 @@ 266 266 (% class="box successmessage" %) 267 267 ((( 268 268 **Note: **The resource created from POST calls towards "offline-capture" operation is actually a "capture" resource, not "offline-capture". 269 -Execute GET calls to the capture resource to retreive previously made offline- captures266 +Execute GET calls to the capture resource to retreive previously made offline-purchases 270 270 ))) 271 271 272 -==== Get offline- captures ====269 +==== Get offline-purchases ==== 273 273 274 274 {{code language="http" title="**Request**"}} 275 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY HTTP/1.1272 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY HTTP/1.1 276 276 Host: - 277 277 Authorization: Bearer <Token> 278 278 Content-Type: application/json ... ... @@ -279,10 +279,10 @@ 279 279 280 280 {{/code}} 281 281 282 -==== List offline- captures ====279 +==== List offline-purchases ==== 283 283 284 284 {{code language="http" title="**Request**"}} 285 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures HTTP/1.1282 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases HTTP/1.1 286 286 Host: - 287 287 Authorization: Bearer <Token> 288 288 Content-Type: application/json ... ... @@ -289,7 +289,7 @@ 289 289 290 290 {{/code}} 291 291 292 -==== Operation offline- captures response ====289 +==== Operation offline-purchases response ==== 293 293 294 294 {{code language="http" title="**Request**"}} 295 295 HTTP/1.1 201 CREATED ... ... @@ -296,20 +296,20 @@ 296 296 Content-Type: application/json 297 297 298 298 { 299 - " captures" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/captures/YYY"296 + "purchases" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY" 300 300 } 301 301 {{/code}} 302 302 303 -== Refunds ==300 +== reversals == 304 304 305 305 Used to refund a transaction without any reference to it. 306 306 307 -==== Create re funds ====304 +==== Create reversals ==== 308 308 309 309 Execute post towards this resource to place the amount on the specified account 310 310 311 311 {{code language="http" title="**Request**"}} 312 -POST /ledger/credit-account-acquiring/v1/XXX/re funds HTTP/1.1309 +POST /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1 313 313 Host: - 314 314 Authorization: Bearer <Token> 315 315 Content-Type: application/json ... ... @@ -329,10 +329,10 @@ 329 329 } 330 330 {{/code}} 331 331 332 -==== Get re funds ====329 +==== Get reversals ==== 333 333 334 334 {{code language="http" title="**Request**"}} 335 -GET /ledger/credit-account-acquiring/v1/XXX/re funds HTTP/1.1332 +GET /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1 336 336 Host: - 337 337 Authorization: Bearer <Token> 338 338 Content-Type: application/json ... ... @@ -339,10 +339,10 @@ 339 339 340 340 {{/code}} 341 341 342 -==== List re funds ====339 +==== List reversals ==== 343 343 344 344 {{code language="http" title="**Request**"}} 345 -GET /ledger/credit-account-acquiring/v1/XXX/re funds HTTP/1.1342 +GET /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1 346 346 Host: - 347 347 Authorization: Bearer <Token> 348 348 Content-Type: application/json ... ... @@ -349,7 +349,7 @@ 349 349 350 350 {{/code}} 351 351 352 -==== Resource re funds ====349 +==== Resource reversals ==== 353 353 354 354 {{code language="http" title="**Response**"}} 355 355 HTTP/1.1 200 OK ... ... @@ -367,13 +367,13 @@ 367 367 "sourceRefundTransactionId" : "534313", 368 368 "amount": 200.00, 369 369 "currency": "SEK", 370 - "@id" : "/ledger/credit-account-acquiring/v1/XXX/r eversals/YYY",367 + "@id" : "/ledger/credit-account-acquiring/v1/XXX/corrections/YYY", 371 371 "parentHREF": "", 372 372 "operations" : [] 373 373 } 374 374 {{/code}} 375 375 376 -==== Refunds properties ====373 +==== reversals properties ==== 377 377 378 378 (% class="table-bordered table-striped" %) 379 379 |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description ... ... @@ -390,14 +390,14 @@ 390 390 |(% 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 391 391 |(% style="width:215px" %)sellerReceiptId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %) 392 392 393 -== Reversals==390 +== corrections == 394 394 395 395 Used to reverse a capture transaction 396 396 397 -==== Create r eversals====394 +==== Create corrections ==== 398 398 399 399 {{code language="http" title="**Request**"}} 400 -POST /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/reversalsHTTP/1.1397 +POST /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections HTTP/1.1 401 401 Host: - 402 402 Authorization: Bearer <Token> 403 403 Content-Type: application/json ... ... @@ -413,10 +413,10 @@ 413 413 } 414 414 {{/code}} 415 415 416 -==== Get r eversals====413 +==== Get corrections ==== 417 417 418 418 {{code language="http" title="**Request**"}} 419 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/reversals/NNN HTTP/1.1416 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections/NNN HTTP/1.1 420 420 Host: - 421 421 Authorization: Bearer <Token> 422 422 Content-Type: application/json ... ... @@ -423,10 +423,10 @@ 423 423 424 424 {{/code}} 425 425 426 -==== List r eversals====423 +==== List corrections ==== 427 427 428 428 {{code language="http" title="**Request**"}} 429 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/reversalsHTTP/1.1426 +GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections HTTP/1.1 430 430 Host: - 431 431 Authorization: Bearer <Token> 432 432 Content-Type: application/json ... ... @@ -433,7 +433,7 @@ 433 433 434 434 {{/code}} 435 435 436 -==== Resource r eversals====433 +==== Resource corrections ==== 437 437 438 438 {{code language="http" title="**Response**"}} 439 439 HTTP/1.1 200 OK ... ... @@ -447,13 +447,13 @@ 447 447 "sourceReversalTransactionId" : "534313", 448 448 "amount": 200.00, 449 449 "currency": "SEK", 450 - "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY/credits/ZZZ",451 - "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/ captures/YYY",447 + "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/credits/ZZZ", 448 + "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY", 452 452 "operations" : [] 453 453 } 454 454 {{/code}} 455 455 456 -==== Reversalsresource properties ====453 +==== corrections resource properties ==== 457 457 458 458 (% class="table-bordered table-striped" %) 459 459 |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description ... ... @@ -519,7 +519,7 @@ 519 519 520 520 === RKHA21 format === 521 521 522 -If the original source for the transactions towards Captures/Reversals/Refunds/Offline-captures is the RKHA21 file the below rules should be used to set the AcquirerBatchId.519 +If the original source for the transactions towards purchases/corrections/reversals/Offline-purchases is the RKHA21 file the below rules should be used to set the AcquirerBatchId. 523 523 524 524 AcquirerBatchId = [Processing date][Sender][Cycle] 525 525