Changes for page card-transaction

Last modified by David Persson on 2024/02/21 07:48
From version 11.5
edited by David Persson
on 2020/02/21 02:01
To version 12.1
edited by David Persson
on 2020/02/21 02:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,6 +2,8 @@
2 2  (((
3 3  (% class="container" %)
4 4  (((
5 +
6 +
5 5  Integrate to **PayEx Ledger Card transactions API **
6 6  )))
7 7  )))
... ... @@ -319,32 +319,36 @@
319 319  
320 320  ----
321 321  
322 -=== Correction (Purchase) ===
324 +=== Reversals ===
323 323  
324 -Used to reverse a Purchase transaction
326 +Used to refund a transaction without any reference to it.
325 325  
326 -==== Create corrections ====
328 +==== Create reversals ====
327 327  
330 +Execute post towards this resource to place the amount on the specified account
331 +
328 328  {{code language="http" title="**Request**"}}
329 -POST /ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections HTTP/1.1
333 +POST /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
330 330  Host: -
331 331  Authorization: Bearer <Token>
332 332  Content-Type: application/json
333 333  
334 334  {
339 + "authorizationId" : "AUTH71",
340 + "sellerReceiptId": "12345689",
335 335   "additionalReferences":{
336 336   "acquirerBatchId": "fdsfsdfsd",
337 337   "acquirerTransactionId" : "534313",
338 338   },
339 - "sourceCorrectionTransactionId" : "534313",
345 + "sourceReversalTransactionId" : "534312",
340 340   "amount": 200.0
341 341  }
342 342  {{/code}}
343 343  
344 -==== Get corrections ====
350 +==== Get reversals ====
345 345  
346 346  {{code language="http" title="**Request**"}}
347 -GET /ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections/NNN HTTP/1.1
353 +GET /ledger/credit-account-acquiring/v1/XXX/reversals/YYY HTTP/1.1
348 348  Host: -
349 349  Authorization: Bearer <Token>
350 350  Content-Type: application/json
... ... @@ -351,10 +351,10 @@
351 351  
352 352  {{/code}}
353 353  
354 -==== List corrections ====
360 +==== List reversals ====
355 355  
356 356  {{code language="http" title="**Request**"}}
357 -GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections HTTP/1.1
363 +GET /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
358 358  Host: -
359 359  Authorization: Bearer <Token>
360 360  Content-Type: application/json
... ... @@ -361,7 +361,7 @@
361 361  
362 362  {{/code}}
363 363  
364 -==== Resource corrections ====
370 +==== Resource reversals ====
365 365  
366 366  {{code language="http" title="**Response**"}}
367 367  HTTP/1.1 200 OK
... ... @@ -368,23 +368,25 @@
368 368  Content-Type: application/json
369 369  
370 370  {
377 + "authorizationId" : "AUTH71",
378 + "sellerReceiptId": "12345689",
371 371   "additionalReferences":{
372 372   "acquirerBatchId": "fdsfsdfsd",
373 373   "acquirerTransactionId" : "534313",
374 374   },
375 - "sourceCorrectionTransactionId" : "534313",
376 - "amount": 200.00,
377 - "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections/ZZZ",
378 - "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY",
383 + "sourceReversalTransactionId" : "534312",
384 + "amount": 200.0,
385 + "@id" : "/ledger/credit-account-acquiring/v1/XXX/reversals/YYY",
379 379   "operations" : []
380 380  }
381 381  {{/code}}
382 382  
383 -==== corrections resource properties ====
390 +==== reversals properties ====
384 384  
385 385  (% class="table-bordered table-striped" %)
386 386  |=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
387 387  |(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
395 +|(% 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 originated from
388 388  |(% style="width:337px" %)(((
389 389  additionalReferences.acquirerBatchId
390 390  )))|(% 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
... ... @@ -391,88 +391,132 @@
391 391  |(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction
392 392  |(% style="width:215px" %)sourceReversalTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %)
393 393  |(% style="width:215px" %)amount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
394 -|(% style="width:215px" %)currency|(% style="width:114px" %)string|(% style="width:118px" %)[[ISO 4217>>url:https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:586px" %)
395 395  
396 -== Reversals ==
403 +=== Corrections ===
397 397  
398 -Used to refund a transaction without any reference to it.
405 +Used to reverse a Purchase transaction
399 399  
400 -==== Create reversals ====
407 +==== Create purchase corrections ====
401 401  
402 -Execute post towards this resource to place the amount on the specified account
403 -
404 404  {{code language="http" title="**Request**"}}
405 -POST /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
410 +POST /ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections HTTP/1.1
406 406  Host: -
407 407  Authorization: Bearer <Token>
408 408  Content-Type: application/json
409 409  
410 410  {
411 - "authorizationId" : "AUTH71",
412 - "sellerReceiptId": "12345689",
413 413   "additionalReferences":{
414 414   "acquirerBatchId": "fdsfsdfsd",
415 415   "acquirerTransactionId" : "534313",
416 416   },
417 - "sourceReversalTransactionId" : "534312",
420 + "sourceCorrectionTransactionId" : "534313",
418 418   "amount": 200.0
419 419  }
420 420  {{/code}}
421 421  
422 -==== Get reversals ====
425 +==== Create cash-withdrawal corrections ====
423 423  
424 424  {{code language="http" title="**Request**"}}
425 -GET /ledger/credit-account-acquiring/v1/XXX/reversals/YYY HTTP/1.1
428 +POST /ledger/credit-account-acquiring/v1/XXX/cash-withdrawal/YYY/corrections HTTP/1.1
426 426  Host: -
427 427  Authorization: Bearer <Token>
428 428  Content-Type: application/json
429 429  
433 +{
434 + "additionalReferences":{
435 + "acquirerBatchId": "fdsfsdfsd",
436 + "acquirerTransactionId" : "534313",
437 + },
438 + "sourceCorrectionTransactionId" : "534313",
439 + "amount": 200.0
440 +}
430 430  {{/code}}
431 431  
432 -==== List reversals ====
443 +==== Create reversal corrections ====
433 433  
434 434  {{code language="http" title="**Request**"}}
435 -GET /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
446 +POST /ledger/credit-account-acquiring/v1/XXX/reversals/YYY/corrections HTTP/1.1
436 436  Host: -
437 437  Authorization: Bearer <Token>
438 438  Content-Type: application/json
439 439  
440 -{{/code}}
441 -
442 -==== Resource reversals ====
443 -
444 -{{code language="http" title="**Response**"}}
445 -HTTP/1.1 200 OK
446 -Content-Type: application/json
447 -
448 448  {
449 - "authorizationId" : "AUTH71",
450 - "sellerReceiptId": "12345689",
451 451   "additionalReferences":{
452 452   "acquirerBatchId": "fdsfsdfsd",
453 453   "acquirerTransactionId" : "534313",
454 454   },
455 - "sourceReversalTransactionId" : "534312",
456 - "amount": 200.0,
457 - "@id" : "/ledger/credit-account-acquiring/v1/XXX/reversals/YYY",
458 - "operations" : []
456 + "sourceCorrectionTransactionId" : "534313",
457 + "amount": 200.0
459 459  }
460 460  {{/code}}
461 461  
462 -==== reversals properties ====
461 +(% class="wikigeneratedid" %)
462 +==== ====
463 463  
464 +(% class="wikigeneratedid" %)
465 +==== ====
466 +
467 +(% class="wikigeneratedid" %)
468 +==== Corrections resource properties ====
469 +
464 464  (% class="table-bordered table-striped" %)
465 -|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description
466 -|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: |(% style="width:586px" %)
467 -|(% 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 originated from
471 +|=(% style="width: 215px;" %)(((
472 +Property
473 +)))|=(% style="width: 114px;" %)(((
474 +Data type
475 +)))|=(% style="width: 118px;" %)(((
476 +Format
477 +)))|=(% style="width: 586px;" %)(((
478 +Description
479 +)))
480 +|(% style="width:215px" %)(((
481 +@id
482 +)))|(% style="width:114px" %)(((
483 +string
484 +)))|(% style="width:118px" %)(((
485 +Maxlength:
486 +)))|(% style="width:586px" %)(((
487 +
488 +)))
468 468  |(% style="width:337px" %)(((
469 469  additionalReferences.acquirerBatchId
470 -)))|(% 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
471 -|(% style="width:337px" %)additionalReferences.acquirerTransactionId|(% style="width:121px" %)string|(% style="width:164px" %)Maxlength: 50|(% style="width:1156px" %)Unique acquirer identifier of the transaction
472 -|(% style="width:215px" %)sourceReversalTransactionId|(% style="width:114px" %)string|(% style="width:118px" %)Maxlength: 50|(% style="width:586px" %)
473 -|(% style="width:215px" %)amount|(% style="width:114px" %)decimal|(% style="width:118px" %) |(% style="width:586px" %)
491 +)))|(% style="width:121px" %)(((
492 +string
493 +)))|(% style="width:164px" %)(((
494 +Maxlength: 50
495 +)))|(% style="width:1156px" %)(((
496 +Used for reconciling acquirer transactions. See [[RKHA21>>||anchor="HRKHA21format"]] section on this page for more information
497 +)))
498 +|(% style="width:337px" %)(((
499 +additionalReferences.acquirerTransactionId
500 +)))|(% style="width:121px" %)(((
501 +string
502 +)))|(% style="width:164px" %)(((
503 +Maxlength: 50
504 +)))|(% style="width:1156px" %)(((
505 +Unique acquirer identifier of the transaction
506 +)))
507 +|(% style="width:215px" %)(((
508 +sourceCorrectionTransactionId
509 +)))|(% style="width:114px" %)(((
510 +string
511 +)))|(% style="width:118px" %)(((
512 +Maxlength: 50
513 +)))|(% style="width:586px" %)(((
514 +
515 +)))
516 +|(% style="width:215px" %)(((
517 +amount
518 +)))|(% style="width:114px" %)(((
519 +decimal
520 +)))|(% style="width:118px" %)(((
521 +
522 +)))|(% style="width:586px" %)(((
523 +
524 +)))
474 474  
475 -=== RKHA21 format ===
526 +(% class="wikigeneratedid" %)
527 +==== RKHA21 format ====
476 476  
477 477  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.
478 478  
... ... @@ -483,22 +483,113 @@
483 483  **RKHA21 file header row description**
484 484  
485 485  (% class="table-bordered table-striped" %)
486 -|=(% style="width: 113px;" %)Position|=(% style="width: 226px;" %)Field|=(% style="width: 118px;" %)Format|=(% style="width: 586px;" %)Description|=(% style="width: 586px;" %)Example
487 -|(% style="width:113px" %)1|(% style="width:226px" %)Transaction code|(% style="width:118px" %)2 N|(% style="width:586px" %)01|(% style="width:586px" %)
488 -|(% style="width:113px" %)3|(% style="width:226px" %)Processing date|(% style="width:118px" %)6 N|(% style="width:586px" %)YYMMDD|(% style="width:586px" %)200206
489 -|(% style="width:113px" %)9|(% style="width:226px" %)Sender|(% style="width:118px" %)4 N|(% style="width:586px" %)"8850" (Babs)|(% style="width:586px" %)8850
490 -|(% style="width:113px" %)13|(% style="width:226px" %)Cycle|(% style="width:118px" %)2 AN|(% style="width:586px" %)10/20|(% style="width:586px" %)20
491 -|(% style="width:113px" %)15|(% style="width:226px" %)Filler|(% style="width:118px" %)26 AN|(% style="width:586px" %)Space characters|(% style="width:586px" %)
492 -|(% style="width:113px" %)41|(% style="width:226px" %)Vers.nr/serial number|(% style="width:118px" %)6 N|(% style="width:586px" %)File serial number|(% style="width:586px" %)
493 -|(% style="width:113px" %)47|(% style="width:226px" %)Transaction entry|(% style="width:118px" %)1 AN|(% style="width:586px" %) |(% style="width:586px" %)
494 -|(% style="width:113px" %)48|(% style="width:226px" %)Filler|(% style="width:118px" %)333 AN|(% style="width:586px" %)Space characters|(% style="width:586px" %)
538 +|=(% style="width: 113px;" %)(((
539 +Position
540 +)))|=(% style="width: 226px;" %)(((
541 +Field
542 +)))|=(% style="width: 118px;" %)(((
543 +Format
544 +)))|=(% style="width: 586px;" %)(((
545 +Description
546 +)))|=(% style="width: 586px;" %)(((
547 +Example
548 +)))
549 +|(% style="width:113px" %)(((
550 +1
551 +)))|(% style="width:226px" %)(((
552 +Transaction code
553 +)))|(% style="width:118px" %)(((
554 +2 N
555 +)))|(% style="width:586px" %)(((
556 +01
557 +)))|(% style="width:586px" %)(((
558 +
559 +)))
560 +|(% style="width:113px" %)(((
561 +3
562 +)))|(% style="width:226px" %)(((
563 +Processing date
564 +)))|(% style="width:118px" %)(((
565 +6 N
566 +)))|(% style="width:586px" %)(((
567 +YYMMDD
568 +)))|(% style="width:586px" %)(((
569 +200206
570 +)))
571 +|(% style="width:113px" %)(((
572 +9
573 +)))|(% style="width:226px" %)(((
574 +Sender
575 +)))|(% style="width:118px" %)(((
576 +4 N
577 +)))|(% style="width:586px" %)(((
578 +"8850" (Babs)
579 +)))|(% style="width:586px" %)(((
580 +8850
581 +)))
582 +|(% style="width:113px" %)(((
583 +13
584 +)))|(% style="width:226px" %)(((
585 +Cycle
586 +)))|(% style="width:118px" %)(((
587 +2 AN
588 +)))|(% style="width:586px" %)(((
589 +10/20
590 +)))|(% style="width:586px" %)(((
591 +20
592 +)))
593 +|(% style="width:113px" %)(((
594 +15
595 +)))|(% style="width:226px" %)(((
596 +Filler
597 +)))|(% style="width:118px" %)(((
598 +26 AN
599 +)))|(% style="width:586px" %)(((
600 +Space characters
601 +)))|(% style="width:586px" %)(((
602 +
603 +)))
604 +|(% style="width:113px" %)(((
605 +41
606 +)))|(% style="width:226px" %)(((
607 +Vers.nr/serial number
608 +)))|(% style="width:118px" %)(((
609 +6 N
610 +)))|(% style="width:586px" %)(((
611 +File serial number
612 +)))|(% style="width:586px" %)(((
613 +
614 +)))
615 +|(% style="width:113px" %)(((
616 +47
617 +)))|(% style="width:226px" %)(((
618 +Transaction entry
619 +)))|(% style="width:118px" %)(((
620 +1 AN
621 +)))|(% style="width:586px" %)(((
622 +
623 +)))|(% style="width:586px" %)(((
624 +
625 +)))
626 +|(% style="width:113px" %)(((
627 +48
628 +)))|(% style="width:226px" %)(((
629 +Filler
630 +)))|(% style="width:118px" %)(((
631 +333 AN
632 +)))|(% style="width:586px" %)(((
633 +Space characters
634 +)))|(% style="width:586px" %)(((
635 +
636 +)))
495 495  
496 496  (% class="box successmessage" %)
497 497  (((
498 -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.
640 +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.
499 499  )))
500 500  
501 -=== Problems ===
643 +(% class="wikigeneratedid" %)
644 +==== Problems ====
502 502  
503 503  If an error occur or any validation failed, a "problem" response will be returned.
504 504  Below is a list of problems that can occur:
... ... @@ -505,38 +505,72 @@
505 505  
506 506  **HttpStatus 401 Unauthorized**
507 507  
508 -* Token expired
509 -* Token invalid
510 -* SellerNumber does not match token
511 -* CompanyNumber does not match token
651 +* (((
652 +Token expired
653 +)))
654 +* (((
655 +Token invalid
656 +)))
657 +* (((
658 +SellerNumber does not match token
659 +)))
660 +* (((
661 +CompanyNumber does not match token
662 +)))
512 512  
513 513  **HttpStatus 400 Error**
514 514  
515 -* Validation: Argument required
516 -* Validation: Invalid value
666 +* (((
667 +Validation: Argument required
668 +)))
669 +* (((
670 +Validation: Invalid value
671 +)))
517 517  
518 518  **HttpStatus 422 Unprocessable entity**
519 519  
520 -* Authorization declined
675 +* (((
676 +Authorization declined
677 +)))
521 521  
522 522  **HttpStatus 409 Conflict**
523 523  
524 -* Invoice already authorized
525 -* Duplicate InvoiceNumber
526 -* Authorization is cancelled
527 -* Authorization already Purchased
528 -* Authorization has expired
529 -* Insufficient debited amount XXX
681 +* (((
682 +Invoice already authorized
683 +)))
684 +* (((
685 +Duplicate InvoiceNumber
686 +)))
687 +* (((
688 +Authorization is cancelled
689 +)))
690 +* (((
691 +Authorization already Purchased
692 +)))
693 +* (((
694 +Authorization has expired
695 +)))
696 +* (((
697 +Insufficient debited amount XXX
698 +)))
530 530  
531 531  **HttpStatus 501 NotImplemented**
532 532  
533 -* CompanyNumber XXX not configured
534 -* SellerNumber XXX not configured at PayEx
535 -* CompanyNumber XXX missing configuration
702 +* (((
703 +CompanyNumber XXX not configured
704 +)))
705 +* (((
706 +SellerNumber XXX not configured at PayEx
707 +)))
708 +* (((
709 +CompanyNumber XXX missing configuration
710 +)))
536 536  
537 537  **HttpStatus 404 NotFound**
538 538  
539 -* Authorization not found
714 +* (((
715 +Authorization not found
716 +)))
540 540  
541 541  Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.
542 542