Changelog

2020-01-31
renamed resource "recurring-payment-consent" to "recurring-payment-setting" (not implemented in API yet)

This api is used to retrieve information and to change properties related to the customer's credit account.

Introduction

Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
The below route is an example of a route towards resource3Id, to operate on this resource you must also include the ids of its parentresources in the route.
api.payex.com/ledger/{Subdomain}/v1/{LedgerNumber}/resource1/{resource1Id}/resource2/{resource2Id}/resource3/{resource3Id}

Route segment	Description
Subdomain	In this part of the API it will be credit-account
LedgerNumber	The ledger identifier/number at PayEx
resource1Id	Identifier of resource1
resource2Id	identifier of resource2, subresource to resource1
resource3Id	identifier of resource3, subresource to resource2

Routes that occurs in examples of this documentation will use the following identifiers

Resource	Identifier
LedgerNumber	XXX
Accounts	NNN
Bills	reminder-123 bill-456
Cards	954c8699-b38f-47a2-b568-668b8837dad8 274c8699-b38f-47a2-b568-668b8837dat7

Accounts

The accounts resource is located under ledger/credit-account/v1/ api. The accounts- and its sub-resources are used to create, read and modify information related to a credit-account.
The accounts resource provides an overview of the end customer's account, it contains information such as current balance, credit limit etc. The resource also contains URIs for additional sub-resources such as bills, cards, recurring payments, etc.
The following operations is supported

• Change the account credit limit
• Add extra cards
• Request cancellation of account
• Turn on/off charity donation
• Set behaviour of recurring payments

Requesting details of a specific account

Resource properties

Property	Data type	Format	Modify (patch)	Description
@id	string	Maxlength:		Uri of the specific account
accountNo	string	Maxlength: 50		The identifier of the account
startDate	date	ISO 8601		Date when the account was started
description	string	Maxlength: 200		A description of the type of account
accountProfileType	string	Maxlength: 50		The defined code of the accounttype, Examples: kontodebet, kontokredit, kontofaktura
accountAlias	string	Maxlength: 50		A descriptive name for the account type, Examples: kontokredit1, matkonto1
customerNo	string	Maxlength: 50		Identifier of the customer (account owner)
status	string	Maxlength: 25		Status of the account pending-close: the customer has requested the account to be closed, the account will be closed when possible. open: the account is open and active closed: the account has been closed
creditLimit	decimal			The creditlimit of the account, support patch operation but only lower
totalBalance	decimal			Total current sum of all balances (including capital / interest / fees, etc.)
reservedAmount	decimal			Sum of all outstanding reservations (which are valid and not captured)
availableAmount	decimal			Available credit (cannot be calculated from the above amounts as fees can be included there, which does not affect available credit)
openBill	string	Uri
charityDonation	bool			If donations should be made from the account
interestRate.debtInterest	decimal	Percentage		yearly debt interestrate
interestRate.penaltyInterest	decimal	Percentage		yearly penalty interestrate
offer	string	Uri
recurringPaymentConsent	string	Uri
cards	string	Uri
transactions	string	Uri
currency	string	ISO 4217
bills	string	Uri
customer	string	Uri
activePaymentOrder.paymentMethod	string	Maxlength: 15		PaymentTypes: AUTOGIRO
activePaymentOrder.executionDate	date	ISO 8601		Date when the paymentorder will be executed (when end-customer will be debited)
activePaymentOrder.amount	decimal			Amount that will be charged, this amount may be adjusted when the payment order is executed, if the "amount to pay" on the bill has decreased

Bills

The bills resources contains all the documents produced in the accounts billing cycle.

Requesting list of bills belonging to a specific account

Requesting details of a specific bill

Property	Data type	Format	Description
@id	string	Uri
dueDate	date	ISO 8601
billDate	date		Date when bill was created
billNo	string	Maxlength: 50	The identifier of the bill
billAmount	decimal		the amount that is stated on the actual bill/document
billType	string	Maxlength: 25	BillTypes: Bill Reminder1 Reminder2 Collection
status	string		"open" / "closed"
activePaymentDetails	object		only set if status of bill is "open"
activePaymentDetails.minimumAmountToBePayed	decimal		The least amount to pay on the bill
activePaymentDetails.bankAccountNo	string	Maxlength: 15	bankaccount for payment
activePaymentDetails.bankAccountType	string	Maxlength: 10	BankAccountTypes: BKSE (swedish bankaccount) PKSE (swedish plusgiro) BGSE (swedish bankgiro) PGSE (swedish plusgiro OCR)
activePaymentDetails.bic	string	Maxlength: 11	Bank Identifier Code (BIC)
activePaymentDetails.iban	string	Maxlength: 34	International Bank Account Number (IBAN)
activePaymentDetails.paymentReference	string	Maxlength: 50	reference to specify on the payment
activePaymentDetails.paymentOrdersExists	bool		if there is an active payment order to be executed related to this bill for "recurring payments". More detailed information about the payment order can be found on the accounts resource
document	string	Url	Url to download pdf document

recurring-payment-setting

This resource contain information/settings related to how recurring payments should behave on this account.

Requesting the resource

Update settings

Execute http patch towards this resource to change how recurring payments should behave on the specified account

Property	Data type	Format	Modify (patch)	Description
recurringPaymentMethod	string			recurringPaymentMethods: autogiro
recurringPaymentScope	string			recurringPaymentScopes: fixedRecurring (Fixed amount to debit monthly) totalDebt (Total credit-account debt will be debited) billedAmount (Only the minimum amount to pay will be debited)
fixedRecurringAmount	decimal			amount to monthly debit end-customers bankaccount (Only valid if recurringPaymentScope is set to "fixedRecurring")

Cards

Post

Execute http post towards this resource to add a new card to the specified account

List cards

Get

Property	Data type	Format	Modify (patch)	Description
token	string			token identifier of the card
panTrunc	string			truncated PAN
deleted	bool			indicates wheter the card has been deleted
mainCard	bool			indicated whether this card is the main card of the account (cardholder is always owner of account)
cardHolder.number	string			Cardholder customernumber
cardHolder.name	string			Cardholder fullname
cardHolder.nationalConsumerIdentifier.value	string	YYYYMMDD-NNNC
cardHolder.nationalConsumerIdentifier.countryCode	string	ISO 3166-1 alpha-2

Transactions

Property	Data type	Format	Description
type	string		Type of transaction Payment Purchase Credit
description	string		Description of the transaction, for purchases it usually includes "point of sale" and "receipt reference"
amount	decimal
billed	bool		Indicates wheter a bill has been created after the transaction (ie. if the transaction is included in any bill or not)
date	date		Valuedate

Reservations

Property	Data type	Format	Description
amount	decimal
description	string		Description of the reservation, normally "point of sale".
date	date		Date when the reservation occured 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" } ] }