Integrate to PayEx Credit Account Acquiring 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

2020-02-03
Renamed parameters
sellerCaptureTransactionId -> sourceCaptureTransactionId
sellerReversalTransactionId -> sourceReversalTransactionId

2020-01-30
Added "reversals" resource to use when reversal is made with card and the original capture cannot be referenced.

2020-01-30
renamed sellerAuthorizationTransactionId to sourceAuthorizationTransactionId

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 capture 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-capture",
           "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 used in capture
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
accountNo	string		identifier of the account
pointOfSale	string	Maxlength: 50	Name of the location/point/shop of sale, will be returned in reservation resource
validToDate	date	ISO 8601	Capture can not be executed after this date
authorizeAmount	decimal	Amount	Original authorized amount
remainingAmount	decimal	Amount	Amount left on the authorization that can be captured
currency	string	ISO 4217
purchases	string	Uri
cancellations	string	Uri

Purchases

Post purchases

Request

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

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

Get purchases

Request

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

List purchases

Request

GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/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",
   "sourceCaptureTransactionId" : "534313",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sellerReceiptId": "12345689",
   "amount": 200.0,
   "corrections": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/corrections",
   "@id": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/capture/YYY",
   "parentHREF": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN",
   "operations": [
        {
           "rel": "create-reversal",
           "method": "post",
           "href": "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/reversal"
        }
    ]
}

Resource properties purchases

Property	Data type	Format	Description
@id	string	Uri
description	string	Maxlength: 200	Describes the current capture (derives from info sent in the authorization), may be printed on the bill, output only
sourceCaptureTransactionId	string	Maxlength: 50	Unique identifier of the capture 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
corrections	string	Uri

Offline-purchases

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.

Note! This is not a general purpose function. The agreement between the client and PayEx will dictate if the function can be used.

Post offline-purchases

Request

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

{
   "pointOfSale": "stora butiken test, köpref. 12345689",
   "sourceCaptureTransactionId" : "534313",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sellerReceiptId": "12345689",
   "sellerNumber" : "654",
   "cardToken" : "1564316498964156",
   "accountToken" : null,
   "captureAmount": 300.0,
   "currency": "SEK",
   "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY",
   "credits" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/credits",
   "schemaUri": "/ledger/invoice-purchase/v1/PayEx.AR.InvoicePurchase.Api.Resources.Authorizations.Resource",
   "parentHREF": "/",
   "operations" : []
}

Note: The resource created from POST calls towards "offline-capture" operation is actually a "capture" resource, not "offline-capture".
Execute GET calls to the capture resource to retreive previously made offline-purchases

Get offline-purchases

Request

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

List offline-purchases

Request

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

Operation offline-purchases response

Request

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

{
"purchases" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY"
}

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

{
   "pointOfSale": "stora butiken test, köpref. 12345689",
   "cardToken" : "1564316498964156",
   "sellerReceiptId": "12345689",
   "sellerNumber" : "654",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceRefundTransactionId" : "534312",
   "amount": 200.0,
   "currency": "SEK"
}

Get reversals

Request

GET /ledger/credit-account-acquiring/v1/XXX/reversals 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

{
   "pointOfSale": "stora butiken test, köpref. 12345689",
   "cardToken" : "1564316498964156",
   "sellerReceiptId": "12345689",
   "sellerNumber" : "654",
   "additionalReferences":{
       "acquirerBatchId": "fdsfsdfsd",
       "acquirerTransactionId" : "534313",
    },
   "sourceRefundTransactionId" : "534313",
   "amount": 200.00,
   "currency": "SEK",
   "@id" : "/ledger/credit-account-acquiring/v1/XXX/corrections/YYY",
   "parentHREF": "",
   "operations" : []
}

reversals 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
sourceRefundTransactionId	string	Maxlength: 50
amount	decimal
currency	string	ISO 4217
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
sellerReceiptId	string	Maxlength: 50

corrections

Used to reverse a capture transaction

Create corrections

Request

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

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

Get corrections

Request

GET /ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/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",
    },
   "sourceReversalTransactionId" : "534313",
   "amount": 200.00,
   "currency": "SEK",
   "@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/purchases/YYY/credits/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

Cancellations

Post cancellations

Request

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

Get cancellations

Request

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

Resource cancellations

Response

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

{
"cancellationDate" : "2019-11-20",
"@id" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN/cancellations",
"parentHREF" : "/ledger/credit-account-acquiring/v1/XXX/authorizations/NNN"
}

List cancellations

Request

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

Resource properties

Property	Data type	Format	Description
@id	string	Uri
cancellationDate	date	ISO 8601

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 captured
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

Offline-purchases

Post offline-purchases

Get offline-purchases

List offline-purchases

Operation offline-purchases response

reversals

Create reversals

Get reversals

List reversals

Resource reversals

reversals properties

corrections

Create corrections

Get corrections

List corrections

Resource corrections

corrections resource properties

Cancellations

Post cancellations

Get cancellations

Resource cancellations

List cancellations

RKHA21 format

Problems