Main.credit-account.PayExConnect_API.ExternalServicesManual - ExternalServices manual

Page of - last modified by frn on 2021/06/29 16:53

ExternalServices manual

frn

2021/06/29 16:53

Table of Contents

CreditAccount Service methods

GetBillingAccountCurrentStateByBillingAccountNo11

GetBillPdfByBillNoExternalBillType10

GetClosedBillingAccountByRegNo10

GetOpenBillingAccountByRegNo10

RegisterBillPSPPaymentBillingAccountNo10

RegisterBillDirectPaymentByBillingAccountNo10

CustomerService methods

GetcustomerCurrentStateByCustomerNo

GetCustomerCurrentStateByRegNo10

Appendix 1 Shared Classes

Appendix 2 Code specification

The external services manual cover methods used to retrieve Invoice PDFs as well as invoice and customer information.

CreditAccount Service methods

The complete Wsdl specification for this service can be found at: https:/connect.payex.com//PxR/CreditAccountService.svc?wsdl

(Username/password security model)

GetBillingAccountCurrentStateByBillingAccountNo11

Class diagram

Request parameters

GetBillingAccountCurrentStateByBillingAccountNo11Request
Field	Datatype	Required	Description
BillingAccountNo	String(15)	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetBillingAccountCurrentStateByBillingAccountNo11Response
Field	Datatype	Description
CompanyNo	String
BillingAccount	BillingAccountDetail11
ResponseCode	String
ResponseMessage	String
TraceId	String

Classes

BillingAccountDetail11
Field	Datatype	Description
BillingAccountNo	String
BillingAccountAlias	String
Description	String
OpenBill	BillDetail
PaymentBankAccount	PaymentBankAccount20
PaymentReference	String
ClosedBillHistoryList	List<BillHistory11>
CreditAccountList	List<CreditAccount>
CurrentBillingAccountDebt	Decimal
CurrentBillingAccountAndCreditAccountDebt	Decimal
CurrencyCode	String
StartDate	DateTime
PenaltyInterest	Intrest
CreditAccount
Field	Datatype	Description
CreditAccountNo	String
Description	String
StartDate	DateTime
CreditAccountAlias	String
CurrentBalanceList	List<Balance>
AccountLimit	Decimal
DebtInterest	Intrest

Error codes

GetBillingAccountCurrentStateByBillingAccountNo10Response
Code	Name	Description
5028	MissingAccountForBillingAccount	Cant find BillingAccount in this company.

GetBillPdfByBillNoExternalBillType10

Class diagram

Request parameters

GetBillPdfByBillNoExternalBillType10Request
Field	Datatype	Required	Description
BillNo	String	Yes
ExternalBillType	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetInvoicePdfResponse

GetClosedBillingAccountByRegNo10

Class diagram

Request parameters

GetClosedBillingAccountByRegNo10Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetClosedBillingAccountByRegNo10Response
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
BillingAccountList	List<ClosedBillingAccountInfo>
ResponseCode	String
ResponseMessage	String
TraceId	String

Classes

ClosedBillingAccountInfo
Field	Datatype	Description
BillingAccountNo	String
BillingAccountAlias	String
Description	String

GetOpenBillingAccountByRegNo10

Class diagram

Request parameters

GetOpenBillingAccountByRegNo10Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

GetOpenBillingAccountByRegNo10Response
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
BillingAccountList	List<OpenBillingAccountInfo>
ResponseCode	String
ResponseMessage	String
TraceId	String

Classes

OpenBillingAccountInfo
Field	Datatype	Description
BillingAccountNo	String
BillingAccountAlias	String
Description	String
OpenBill	BillDetail
PaymentBankAccount	PaymentBankAccount
CurrentBillingAccountDebt	decimal
PaymentReference	string

RegisterBillPSPPaymentBillingAccountNo10

Class diagram

Request parameters

RegisterBillPSPPaymentBillingAccountNo10Request
Field	Datatype	Required	Description
BillingAccountNo	string(15)	Yes
Amount	Decimal	Yes
PaymentDate	DateTime	Yes
SellerTransactionId	String	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

RegisterBillPSPPaymentBillingAccountNo10Response
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

RegisterBillDirectPaymentByBillingAccountNo10

Class diagram

Request parameters

RegisterBillDirectPaymentByBillingAccountNo10Request
Field	Datatype	Required	Description
Amount	Decimal	Yes
BillingAccountNo	String(15)	Yes
PaymentDate	DateTime	Yes
TrackingUserEMail	String(1-256)	Yes	User info for trackability.
TraceId	String	Yes

Response parameters

RegisterBillDirectPaymentByBillingAccountNo10Request
Field	Datatype	Description
ResponseCode	String
ResponseMessage	String
TraceId	String

CustomerService methods

The complete Wsdl specification for this service can be found at:
https://connect.internaltest.payex.com/PxR/CustomerService.svc

(Username/password security model)

GetcustomerCurrentStateByCustomerNo

Get information about current state of a customer.

Class diagram

Request parameters

GetCustomerCurrentStateByCustomerNoRequest
Field	Datatype	Required	Description
CustomerNumber	String(15)	Yes
TrackingUserEMail	String	No

Response parameters

GetCustomerCurrentStateByCustomerNoResponse
Field	Datatype	Description
CustomerConsents	CustomerConsent	Array.
CustomerInfo	CustomerInfo
CustomerNo	String
CustomerStatus	CustomerStatus	Array.
RegNo	RegNo

Classes

CustomerConsent
Field	Datatype	Description
ConsentTypeCode	Int	See the consent type codes table for available consent type codes.
CustomerInfo
Field	Datatype	Description
Name	String
DistributionAddressInfo	DistributionAddressInfo
Language	String
LegalEntityCode	Int	See the legal entity codes table for available legal entity codes.
VatNo	String
Category
CustomerStatus
Field	Datatype	Description
CustomerStatusTypeCode	Int	See code specification.
DistributionAddressInfo
Field	Datatype	Required	Description
Addresses	Array	Yes	See address.
EMailAddress	String	No
Cellphone	String	No
Address
Field	Datatype	Required	Description
Addressee	String(72)	Yes
StreetAdress	String(35)	No
ZipCode	String(9)	Yes
City	String(27)	Yes
CoAddress	String(35)	No
CountryCode	String(2)	Yes

GetCustomerCurrentStateByRegNo10

Class diagram

Request parameters

GetCustomerCurrentStateByRegNo10Request
Field	Datatype	Required	Description
RegNo	RegNo	Yes
TrackingUserEMail	String	Yes
TraceId	String	Yes

Response parameters

GetCustomerCurrentStateByRegNo10Response
Field	Datatype	Description
CustomerConsents	CustomerConsent	Array.
CustomerInfo	CustomerInfo
CustomerNo	String
CustomerStatus	CustomerStatus	Array.
RegNo	RegNo

Appendix 1 Shared Classes

Response parameters

GetInvoicePDFResponse
Field	Datatype	Description
Pdf	Byte[]
RegNo	RegNo
CustomerNo	String
ResponseCode	String
ResponseMessage	String
TraceId	String
GetInvoiceInformationResponse
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
CustomerNo	String
CustomerName	String
Invoice	Invoice
ResponseCode	String
ResponseMessage	String
TraceId	String
RegNo
Field	Datatype	Description
CountryCode	String
Value	String
Invoice
Field	Datatype	Description
PaymentReference	String
BillNo	String
BillStatusCode	Int	See the bill type code table for available bill type codes.
ExternalInvoiceId	String
ExternalReference	String
SellerNo	String
BillDate	DateTime
DueDate	DateTime (Optional)
OriginalAmount	Decimal
Interest	Interest
CurrentBalanceList	List <Balance>
CurrencyCode	String
CurrentClaimLevelCode	Int	See the claim level codes table for available claim level codes.
CollectionStatusCode	Int	See the collection status code table for available collection status codes.
PaymentBanAccount	PaymentBankAccount
PaymentType	String
ActiveRespite	ActiveRespite
ActivePaymentOrder	ActivePaymentOrder
BillId	Long
BillTypeCode	Byte	See the bill type code table for available bill type codes.
InvoiceHistory	List <InvoiceHistory>
Interest
Field	Datatype	Description
CurrentInterestRate	decimal
InterestIntervalCode	byte
Balance
Field	Datatype	Description
BalanceTypeCode	int	See the balance type codes table for available balance type codes.
Amount	decimal
PaymentBankAccount20 inherit PaymentBankAccount
Field	Datatype	Description
PaymentTypeName	String
PaymentBankAccount
Field	Datatype	Description
BankAccountNo	String
BankAccountType	String
BIC	String
IBAN	String
ActiveRespite
Field	Datatype	Description
RespiteValidtoDate	DateTime
RespiteTypeCode	int
ActivePaymentOrder
Field	Datatype	Description
PaymentType	String
ExecutionDate	DateTime
InvoiceHistory
Field	Datatype	Description
BillDate	DateTime
BillId	long
BillTypeCode	byte	See the bill type code table for available bill type codes.
GetClosedInvoiceInformation20Response
Field	Datatype	Description
CompanyNo	String
CustomerNo	string
CustomerName	String
InvoiceList	List<ClosedInvoice20>	See ClosedInvoice20
ClosedInvoice20
Field	Datatype	Description
CurrencyCode	String
BillNo	string
BillStatusCode	Int
ExternalInvoiceId	String
BillDate	DateTime
DueDate	DateTime?
ExternalBillType	String
OriginalAmount	Decimal
SellerName	String
SellerNo	String
GetInvoiceInformation20Response
Field	Datatype	Description
CompanyNo	String
RegNo	RegNo
CustomerNo	string
CustomerName	String
Invoice	InvoiceInformation20
InvoiceInformation20 inherit OpenInvoice20
Field	Datatype	Description
PenaltyIntest	Intrest
CurrentBalance	List<Balance>
InvoiceHistory	List<InvoiceHistory20>
InvoiceHistory20
Field	Datatype	Description
BillDate	DateTime
ExternalBillType	String
BillAmount	Decimal?
OpenInvoice20 inherit ClosedInvoice20
Field	Datatype	Description
CurrentDebt	Decimal
PaymentBankAccount	PaymentBankAccount
PaymentType	String
ActiveRespite	ActiveRespite20
ActivePaymentOrder	ActivePaymentOrder
PaymentRefrence	String
ExportedToCollection	Bool
ActiveRespite20
Field	Datatype	Description
RespiteValidToDate	DateTime?
RespiteTypeCode	Int
BillDetail
Field	Datatype	Description
ExternalBillId	String
DueDate	DateTime
ExportedToCollection	Bool
BillNo	String
ActiveRespite	ActiveRespite20
ActivePaymentOrder	ActivePaymentOrder
CurrentBalanceList	List<Balance>
BillHistoryList	List<BillHistory>
BillHistory11
Field	Datatype	Description
BillDate	DateTime
ExternalBillType	String
BillAmount	Decimal
BillNo	String

Appendix 2 Code specification

Bill status codes
BillStatusCodes	Description
1	Open
2	Closed
3	Closed_Diff
4	Closed_Loss
5	Reversed
6	Arrears
7	Closed_Rest
8	Closed_Convert
9	Closed_Sold
10	Closed_Reversal
11	Pending
Claim level codes
ClaimLevelCode	Description
1	Invoice
2	RestReminderSent
3	ReminderSent
4	RestReminderSent
5	SecondReminderSent
6	RestReminderSent
7	CollectionClaimSent
8	RestReminderSent
9*	DebtCollection*
10	Late Fee, credit account
11	TerminationNoticeSent, credit account

*Additional fees and interest may have occured in collection system, but is not included in the response.

Bill type codes
BillTypeCode	Description
1	Invoice
4	CreditInvoice
Consent type codes
ConsentTypeCode	Description
1	BGAGSE
2	EInvoiceB2CSE
3	EInvoiceB2CNO
4	BKAGNO
5	KivraSE
6	EInvoiceB2CFI
CustomerStatus type codes
CustomerStatusTypeCode	Description
1	ConfirmedDeceased
2	ConfirmedBankruptcy
3	ActiveComplaints
Legal entity codes
LegalEntiytCode	Description
None	None
Private	Private
Business	Business
Balance type codes
BalanceTypeCode	Description
0	None
1	Capital
2	ReminderFee
3	PenaltyInterest
4	CalculatedPenaltyInterest
5	CollectionFee
6	BusinessReminderFee
7	BillingFee
8	DelayFee
9	DebtInterest
10	DebtCollectionCharge
11	Rounding
Collection status codes
CollectionStatusCode	Description
1	PreDebtCollection
2	DebtCollection
3	LegalProcess
4	Monitoring
5	External
6	Closed
7	ReturnedWrongAddress