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

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

GetBillingAccountCurrentStateByBillingAccountNo11Response	
			
CompanyNo	String	  	
BillingAccount	BillingAccountDetail11	  	
ResponseCode	String	  	
ResponseMessage	String	  	
TraceId	String	  	

BillingAccountDetail11	
			
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	
			
CreditAccountNo	String	  	
Description	String	  	
StartDate	DateTime	  	
CreditAccountAlias	String	  	
CurrentBalanceList	List<Balance>	  	
AccountLimit	Decimal	  	
DebtInterest	Intrest	  	

GetBillingAccountCurrentStateByBillingAccountNo10Response	
			
5028	MissingAccountForBillingAccount	Cant find BillingAccount in this company.	
GetBillPdfByBillNoExternalBillType10

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

GetInvoicePdfResponse
GetClosedBillingAccountByRegNo10

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

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

ClosedBillingAccountInfo	
			
BillingAccountNo	String	  	
BillingAccountAlias	String	  	
Description	String	  	
GetOpenBillingAccountByRegNo10

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

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

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

RegisterBillPSPPaymentBillingAccountNo10Request	
				
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	  	

RegisterBillPSPPaymentBillingAccountNo10Response	
			
ResponseCode	String	  	
ResponseMessage	String	  	
TraceId	String	  	
RegisterBillDirectPaymentByBillingAccountNo10

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

RegisterBillDirectPaymentByBillingAccountNo10Request	
			
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.

GetCustomerCurrentStateByCustomerNoRequest	
				
CustomerNumber	String(15)	Yes	  	
TrackingUserEMail	String	No	  	

GetCustomerCurrentStateByCustomerNoResponse	
			
CustomerConsents	CustomerConsent	Array.	
CustomerInfo	CustomerInfo	  	
CustomerNo	String	  	
CustomerStatus	CustomerStatus	Array.	
RegNo	RegNo	  	

CustomerConsent	
			
ConsentTypeCode	Int	See the consent type codes table for available consent type codes.	
CustomerInfo	
			
Name	String	  	
DistributionAddressInfo	DistributionAddressInfo	  	
Language	String	  	
LegalEntityCode	Int	See the legal entity codes table for available legal entity codes.	
VatNo	String	  	
Category	  	  	
CustomerStatus	
			
CustomerStatusTypeCode	Int	See code specification.	
DistributionAddressInfo	
				
Addresses	Array	Yes	See address.	
EMailAddress	String	No	  	
Cellphone	String	No	  	
Address	
				
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

GetCustomerCurrentStateByRegNo10Request	
				
RegNo	RegNo	Yes	  	
TrackingUserEMail	String	Yes	  	
TraceId	String	Yes	  	

GetCustomerCurrentStateByRegNo10Response	
			
CustomerConsents	CustomerConsent	Array.	
CustomerInfo	CustomerInfo	  	
CustomerNo	String	  	
CustomerStatus	CustomerStatus	Array.	
RegNo	RegNo	  	
Appendix 1 Shared Classes

GetInvoicePDFResponse	
			
Pdf	Byte[]	  	
RegNo	RegNo	  	
CustomerNo	String	  	
ResponseCode	String	  	
ResponseMessage	String	  	
TraceId	String	  	
GetInvoiceInformationResponse	
			
CompanyNo	String	  	
RegNo	RegNo	  	
CustomerNo	String	  	
CustomerName	String	  	
Invoice	Invoice	  	
ResponseCode	String	  	
ResponseMessage	String	  	
TraceId	String	  	
RegNo	
			
CountryCode	String	  	
Value	String	  	
Invoice	
			
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	
			
CurrentInterestRate	decimal	  	
InterestIntervalCode	byte	  	
Balance	
			
BalanceTypeCode	int	See the balance type codes table for available balance type codes.	
Amount	decimal	  	
PaymentBankAccount20 inherit PaymentBankAccount	
			
PaymentTypeName	String	  	
PaymentBankAccount	
			
BankAccountNo	String	  	
BankAccountType	String	  	
BIC	String	  	
IBAN	String	  	
ActiveRespite	
			
RespiteValidtoDate	DateTime	  	
RespiteTypeCode	int	  	
ActivePaymentOrder	
			
PaymentType	String	  	
ExecutionDate	DateTime	  	
InvoiceHistory	
			
BillDate	DateTime	  	
BillId	long	  	
BillTypeCode	byte	See the bill type code table for available bill type codes.	
GetClosedInvoiceInformation20Response	
			
CompanyNo	String	  	
CustomerNo	string	  	
CustomerName	String	  	
InvoiceList	List<ClosedInvoice20>	See ClosedInvoice20	
ClosedInvoice20	
			
CurrencyCode	String	  	
BillNo	string	  	
BillStatusCode	Int	  	
ExternalInvoiceId	String	  	
BillDate	DateTime	  	
DueDate	DateTime?	  	
ExternalBillType	String	  	
OriginalAmount	Decimal	  	
SellerName	String	  	
SellerNo	String	  	
GetInvoiceInformation20Response	
			
CompanyNo	String	  	
RegNo	RegNo	  	
CustomerNo	string	  	
CustomerName	String	  	
Invoice	InvoiceInformation20	  	
InvoiceInformation20 inherit OpenInvoice20	
			
PenaltyIntest	Intrest	  	
CurrentBalance	List<Balance>	  	
InvoiceHistory	List<InvoiceHistory20>	  	
InvoiceHistory20	
			
BillDate	DateTime	  	
ExternalBillType	String	  	
BillAmount	Decimal?	  	
OpenInvoice20 inherit ClosedInvoice20	
			
CurrentDebt	Decimal	  	
PaymentBankAccount	PaymentBankAccount	  	
PaymentType	String	  	
ActiveRespite	ActiveRespite20	  	
ActivePaymentOrder	ActivePaymentOrder	  	
PaymentRefrence	String	  	
ExportedToCollection	Bool	  	
ActiveRespite20	
			
RespiteValidToDate	DateTime?	  	
RespiteTypeCode	Int	  	
BillDetail	
			
ExternalBillId	String	  	
DueDate	DateTime	  	
ExportedToCollection	Bool	  	
BillNo	String	  	
ActiveRespite	ActiveRespite20	  	
ActivePaymentOrder	ActivePaymentOrder	  	
CurrentBalanceList	List<Balance>	  	
BillHistoryList	List<BillHistory>	  	
BillHistory11	
			
BillDate	DateTime	  	
ExternalBillType	String	  	
BillAmount	Decimal	  	
BillNo	String	  	
Appendix 2 Code specification
Bill status codes	
		
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	
		
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	
		
1	Invoice	
4	CreditInvoice	
Consent type codes	
		
1	BGAGSE	
2	EInvoiceB2CSE	
3	EInvoiceB2CNO	
4	BKAGNO	
5	KivraSE	
6	EInvoiceB2CFI	
CustomerStatus type codes	
		
1	ConfirmedDeceased	
2	ConfirmedBankruptcy	
3	ActiveComplaints	
Legal entity codes	
		
None	None	
Private	Private	
Business	Business	
Balance type codes	
		
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	
		
1	PreDebtCollection	
2	DebtCollection	
3	LegalProcess	
4	Monitoring	
5	External	
6	Closed	
7	ReturnedWrongAddress