Integrate to PayEx Ledger Card transactions API

The credit account acquiring api contains functions that are used in payment scenarios: online, in-store and offline. Before transactions can be created an account must exists.

Changelog

Authorizations

An authorization is made to try to use an account for payment. A successful authorization leads to a reservation on the account, the account is identified through the cardToken or the accountNo. The authorization is not a financial transaction, to make the financial transaction a Purchase must posted on the authorization.

Post authorizations

Request

POST /ledger/credit-account-acquiring/v1/XXX/authorizations HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

{
   "sourceAuthorizationTransactionId": "789",
   "sellerNumber": "654",
   "cardToken": "5646735165",
   "type": "purchase|reversal|cash-withdrawal",
   "pointOfSale": "Testshop",
   "authorizationAmount": 300.0,
   "currency": "SEK"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
"@id": "/ledger/credit-account-acquiring/v1/XXX/authorization/YYY",
}

Get authorizations

Request

GET /ledger/credit-account-acquiring/v1/XXX/authorizations/YYY HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "sourceAuthorizationTransactionId": "789",
   "authorizationId": 123,
   "sellerNumber": "654",
   "cardToken": "546415646315",
   "accountNo": null,
   "pointOfSale": "Testshop",
   "validToDate": "2019-11-28",
   "authorizationAmount": 300.0,
   "remainingAmount" : 150.0,
   "currency": "SEK",
   "@id": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN",
   "purchases": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases",
   "cancellations": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/cancellations",
   "schemaUri": "/ledger/invoice-purchase/v1/PayEx.AR.InvoicePurchase.Api.Resources.Authorizations.Resource",
   "parentHREF": "/",
   "operations": [
        {
           "rel": "create-Purchase",
           "method": "post",
           "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases"
        },
        {
           "rel": "create-cancellation",
           "method": "post",
           "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/cancellations"
        }
    ]
}

Resource properties authorizations

Property	Data type	Format	Description
@id	string	Uri
sourceAuthorizationTransactionId	string	Maxlength: 50	Unique identifier of the specific authorization, generated by source (typically the integrating system)
authorizationId	string	Maxlength: 6	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)
sellerNumber	string	Maxlength: 15	Identifier of the current seller/merchant
cardToken	string		Identifier of the card. The aurhotization is made on the account that the card is linked to
pointOfSale	string	Maxlength: 50	Name of the location/point/shop of sale, will be returned in reservation resource
validToDate	date	ISO 8601	Purchase can not be executed after this date
authorizeAmount	decimal	Amount	Original authorized amount
remainingAmount	decimal	Amount	Amount left on the authorization that can be Purchased
currency	string	ISO 4217
purchases	string	Uri
cancellations	string	Uri

Purchases

Post purchases

Request

POST /ledger/credit-account-acquiring/v1/XXX/purchases HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

{
   "authorizationId" : "AUTH71",
   "sourcePurchaseTransactionId" : "534313",
   "sellerReceiptId": "2019-11-28",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313"
    },
   "amount": 200.0,
   "offlineInfo" : {
       "pointOfSale": "Testshop",
       "cardToken": "5646735165",
       "sellerNumber": "654",
       "currency": "SEK",
    }
}

Get purchases

Request

GET /ledger/credit-account-acquiring/v1/XXX/purchases/YYY HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

List purchases

Request

GET /ledger/credit-account-acquiring/v1/XXX/purchases HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

Resource purchases

Response

HTTP/1.1 201 CREATED
Content-Type: application/json

{
   "description": "stora butiken test, köpref. 12345689",
   "authorizationId" : "AUTH71",
   "sourcePurchaseTransactionId" : "534313",
   "sellerReceiptId": "2019-11-28",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313"
    },
   "amount": 200.0,
   "offlineInfo" : {
       "pointOfSale": "Testshop",
       "cardToken": "5646735165",
       "sellerNumber": "654",
       "currency": "SEK",
    },
   "corrections": "/ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections",
   "@id": "/ledger/credit-account-acquiring/v1/XXX/purchases/YYY",
   "operations": [
        {
           "rel": "create-reversal",
           "method": "post",
           "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections"
        }
    ]
}

Resource properties purchases

Property	Data type	Format	Description
@id	string	Uri
description	string	Maxlength: 200	Describes the current Purchase (derives from info sent in the authorization), may be printed on the bill, output only
authorizationId	string	Maxlength: 6	The id of the authorization from which this purchase originated from (not required if the purchase was made offline)
sourcePurchaseTransactionId	string	Maxlength: 50	Unique identifier of the Purchase transaction
additionalReferences.acquirerBatchId	string	Maxlength: 50	Used for reconciling acquirer transactions. See RKHA21 section on this page for more information
additionalReferences.acquirerTransactionId	string	Maxlength: 50	Unique acquirer identifier of the transaction
sellerReceiptId	string	Maxlength: 50
amount	decimal
offlineInfo.pointOfSale	string	Maxlength: 50	Name of the location/point/shop of sale, will be returned in reservation resource
offlineInfo.cardToken	string		Identifier of the card. The purchase will be made on the account that the card is linked to
offlineInfo.sellerNumber	string	Maxlength: 15	Identifier of the current seller/merchant
corrections	string	Uri

Cash-withdrawals

Post cash-withdrawals

Request

POST /ledger/credit-account-acquiring/v1/XXX/cash-withdrawals HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

{
   "authorizationId" : "AUTH71",
   "sourceCashWithdrawalTransactionId" : "534313",
   "sellerReceiptId": "2019-11-28",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313"
    },
   "amount": 200.0
}

Get cash-withdrawals

Request

GET /ledger/credit-account-acquiring/v1/XXX/cash-withdrawals/YYY HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

List cash-withdrawals

Request

GET /ledger/credit-account-acquiring/v1/XXX/cash-withdrawals HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

Resource cash-withdrawals

Response

HTTP/1.1 201 CREATED
Content-Type: application/json

{
   "description": "stora butiken test, köpref. 12345689",
   "authorizationId" : "AUTH71",
   "sourceCashWithdrawalTransactionId" : "534313",
   "sellerReceiptId": "2019-11-28",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313"
    },
   "amount": 200.0,
   "corrections": "/ledger/credit-account-acquiring/v1/XXX/cash-withdrawals/YYY/corrections",
   "@id": "/ledger/credit-account-acquiring/v1/XXX/cash-withdrawals/YYY",
   "operations": [
        {
           "rel": "create-correction",
           "method": "post",
           "href": "/ledger/credit-account-acquiring/v1/XXX/cash-withdrawals/YYY/corrections"
        }
    ]
}

Resource properties cash-withdrawals

Property	Data type	Format	Description
@id	string	Uri
description	string	Maxlength: 200	Describes the current cash-withdrawals (derives from info sent in the authorization), may be printed on the bill, output only
authorizationId	string	Maxlength: 6	The id of the authorization from which this cash-withdrawal originated from
sourceCashWithdrawalTransactionId	string	Maxlength: 50	Unique identifier of the cash-withdrawal transaction
additionalReferences.acquirerBatchId	string	Maxlength: 50	Used for reconciling acquirer transactions. See RKHA21 section on this page for more information
additionalReferences.acquirerTransactionId	string	Maxlength: 50	Unique acquirer identifier of the transaction
sellerReceiptId	string	Maxlength: 50
amount	decimal
offlineInfo.pointOfSale	string	Maxlength: 50	Name of the location/point/shop of sale, will be returned in reservation resource
offlineInfo.cardToken	string		Identifier of the card. The cash-withdrawal will be made on the account that the card is linked to
offlineInfo.sellerNumber	string	Maxlength: 15	Identifier of the current seller/merchant
corrections	string	Uri

Correction (Purchase)

Used to reverse a Purchase transaction

Create corrections

Request

POST /ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

{
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceCorrectionTransactionId" : "534313",
   "amount": 200.0
}

Get corrections

Request

GET /ledger/credit-account-acquiring/v1/XXX/purchases/YYY/corrections/NNN HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

List corrections

Request

GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

Resource corrections

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceCorrectionTransactionId" : "534313",
   "amount": 200.00,
   "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections/ZZZ",
   "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY",
   "operations" : []
}

corrections resource properties

Property	Data type	Format	Description
@id	string	Maxlength:
additionalReferences.acquirerBatchId	string	Maxlength: 50	Used for reconciling acquirer transactions. See RKHA21 section on this page for more information
additionalReferences.acquirerTransactionId	string	Maxlength: 50	Unique acquirer identifier of the transaction
sourceReversalTransactionId	string	Maxlength: 50
amount	decimal
currency	string	ISO 4217

Reversals

Used to refund a transaction without any reference to it.

Create reversals

Execute post towards this resource to place the amount on the specified account

Request

POST /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

{
   "authorizationId" : "AUTH71",
   "sellerReceiptId": "12345689",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceReversalTransactionId" : "534312",
   "amount": 200.0
}

Get reversals

Request

GET /ledger/credit-account-acquiring/v1/XXX/reversals/YYY HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

List reversals

Request

GET /ledger/credit-account-acquiring/v1/XXX/reversals HTTP/1.1
Host: -
Authorization: Bearer <Token>
Content-Type: application/json

Resource reversals

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "authorizationId" : "AUTH71",
   "sellerReceiptId": "12345689",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceReversalTransactionId" : "534312",
   "amount": 200.0,
   "@id" : "/ledger/credit-account-acquiring/v1/XXX/reversals/YYY",
   "operations" : []
}

reversals properties

Property	Data type	Format	Description
@id	string	Maxlength:
authorizationId	string	Maxlength: 6	The id of the authorization from which this cash-withdrawal originated from
additionalReferences.acquirerBatchId	string	Maxlength: 50	Used for reconciling acquirer transactions. See RKHA21 section on this page for more information
additionalReferences.acquirerTransactionId	string	Maxlength: 50	Unique acquirer identifier of the transaction
sourceReversalTransactionId	string	Maxlength: 50
amount	decimal

RKHA21 format

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.

AcquirerBatchId = [Processing date][Sender][Cycle]

For the example values in the table below the AcquirerBatchId will be "200206885020".

RKHA21 file header row description

Position	Field	Format	Description	Example
1	Transaction code	2 N	01
3	Processing date	6 N	YYMMDD	200206
9	Sender	4 N	"8850" (Babs)	8850
13	Cycle	2 AN	10/20	20
15	Filler	26 AN	Space characters
41	Vers.nr/serial number	6 N	File serial number
47	Transaction entry	1 AN
48	Filler	333 AN	Space characters

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.

Problems

If an error occur or any validation failed, a "problem" response will be returned.
Below is a list of problems that can occur:

HttpStatus 401 Unauthorized

Token expired
Token invalid
SellerNumber does not match token
CompanyNumber does not match token

HttpStatus 400 Error

Validation: Argument required
Validation: Invalid value

HttpStatus 422 Unprocessable entity

Authorization declined

HttpStatus 409 Conflict

Invoice already authorized
Duplicate InvoiceNumber
Authorization is cancelled
Authorization already Purchased
Authorization has expired
Insufficient debited amount XXX

HttpStatus 501 NotImplemented

CompanyNumber XXX not configured
SellerNumber XXX not configured at PayEx
CompanyNumber XXX missing configuration

HttpStatus 404 NotFound

Authorization not found

Below is an example of a problem that will be returned if buyer.nationalConsumerIdentifier.value is not valid in the authorization post request.

Response

HTTP/1.1 400 Error
Content-Type: application/problem+json

{
   "Type": "http://[DNS]/ledger/invoice-purchase/problems/validation",
   "Title": "A validation error occurred",
   "Status": 400,
   "Instance": null,
   "Detail": "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.",
   "Problems": [
        {
           "buyer.nationalConsumerIdentifier.value": "Not a valid SE nationalConsumerIdentifier"
        }
    ]
}

credit-account

../card-transaction

Changelog

Authorizations

Post authorizations

Get authorizations

Resource properties authorizations

Purchases

Post purchases

Get purchases

List purchases

Resource purchases

Resource properties purchases

Cash-withdrawals

Post cash-withdrawals

Get cash-withdrawals

List cash-withdrawals

Resource cash-withdrawals

Resource properties cash-withdrawals

Correction (Purchase)

Create corrections

Get corrections

List corrections

Resource corrections

corrections resource properties

Reversals

Create reversals

Get reversals

List reversals

Resource reversals

reversals properties

RKHA21 format

Problems