Debtor Management Riverty

Logo

Info

Paygate offers individually scalable solutions for financial and debtor accountings – including the downstream processes such as logistics, dunnings or debt collection.

Type

Debtors Management

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)

Abbreviation

Description

Comment

CND

condition

M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

RefNr

ns..30

M

Unique reference number for the enquiry, for example the order number

OrderDesc

ans..768

O

Description of the goods purchased

CustomerID

n..10

M

Customer number

Eventtoken

a2

M

Abbreviation of the action to be done:

<OC> for Order creation

Paytype

ans

M

Billing Details

bdSalutation

ans..10

O

Salutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong.

bdFirstName

ans..24

M

First name of the customer

bdLastName

ans..30

M

Last name or company name

bdDateOfBirth

ans..10

O

Date of birth in the format YYYY-MM-DD

bdStreet

ans..30

M

Street name

bdstreetNr

ans..30

M

house number

bdZip

ans..5

M

Postcode

bdDistrict

ans..30

O

District

bdCity

ans..30

M

City

bdCountryCode

a2

M

Country code, 2 characters according to ISO 3166, DE=Germany

Shipping Details

sdSalutation

ans..10

O

Salutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong

sdFirstName

ans..24

M

First name of the customer

sdLastName

ans..30

M

Last name or company name

sdStreet

ans..30

M

Street name and house number

sdstreetNr

ans..30

M

house number

sdDistrict

ans..30

O

Address addition, e.g. town district

sdZip

ans..5

M

Postcode

sdCity

ans..30

M

City

sdCountryCode

a2

M

Country code, 2 characters according to ISO 3166, DE=Germany

Phone

ans..20

O

Customer’s phone number

Email

ans..100

O

Email address of the customer

MobileNo

ans..20

O

Customer’s mobile telephone number

Articlelist

string

M

Base64 encoded value

items

array

M

Array of items, e.g.: {"items": [{items1 ...}{item2...}]}

items.itemReference

ans..30

M

Position of the line item in the order

items.id

ans..30

M

Article Number

items.description

ans..30

M

Name / Title of the Article

items.quantity

ans..30

M

Total number of items

items.amount

n..10

M

Gross unit price (incl. VAT) in Cent

items.vatAmount

n..10

M

Tax Amount in cents

items.vatPercent

n..10

M

Tax rate of country tax in % as number 19% = 19

items.vatType

string

M

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionType

string

M

SALES_ARTICLE = Sales Article

IBAN_VERIFICATION = IBAN verification

LOYALTY_CARD = Loyalty Card

SHIPPING_COSTS_EXPRESS = Shipping costs (express)

FREE_ARTICLE = Free article

GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

SERVICE_CHARGE = Service Charge

CASH_ON_DELIVERY = Cash on delivery

MARKETPLACE_PROVISION = Marketplace-Provision

SUBSCRIPTION_ORDER = Subscription Order

DISCOUNT = Discount

SHIPPING_COSTS = Shipping costs

DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

AmountAuth

a3

O

Authorization amount in cents

cardholderName

string

C

Name of the cardholder as printed on the card.

Notice: Alphanumeric special characters, listed in EMV Book 4, “Appendix B”. Special characters have been added with EMV 3DS Version 2.3, but not all participants (banks) already support that standard.

expiryDate

string

C

Card expiry in format YYYYMM

AccOwner

ans..30

O

Account holder. Structure: Salutation;FirstName;LastName.

AccBank

ans..40

O

Name of the bank

IBAN

ans..34

C

IBAN is mandatory in case of :

BIC

ans..11

C

BIC is mandatory in case of:

MandateId

ans..35

C

Reference of the SEPA Mandate. Mandatory for SEPA Payments.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

CodeExt

n..10

O

Error code from Riverty

ErrorText

ans..256

O

Error text from Riverty

ReferenzID

n..50

O

Unique ID within information/response from Riverty

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

PayID

ans..32

M

ID issued by Paygate for order creation

InvoiceNr

ns..30

M

Invoice number

RefNr

ns..30

M

Unique reference number, e.g. order number

Date

date

M

Date of invoice (YYYY-MM-DD)

TrackingID

ns..30

O

Shipment Tracking Id from delivery company

TrackingNummer

ns..30

O

Shipment reference of the shop

ParcelService

string

M

Delivery company Eg: DHL

DueDate

date

M

Date on which the invoice is due

InvoiceDate

date

M

Invoice creation date

DeliveryDate

date

M

Date of delivery

Articlelist

string

M

Base64 encoded value

items

array

M

Array of items, e.g.: {"items": [{items1 ...}{item2...}]}

items.itemReference

ans..30

M

Position of the line item in the order

items.id

ans..30

M

Article Number

items.description

ans..30

M

Name / Title of the Article

items.quantity

ans..30

M

Total number of items

items.amount

n..10

M

Gross unit price (incl. VAT) in Cent

items.vatAmount

n..10

M

Tax Amount in cents

items.vatPercent

n..10

M

Tax rate of country tax in % as number 19% = 19

items.vatType

string

M

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionType

string

M

SALES_ARTICLE = Sales Article

IBAN_VERIFICATION = IBAN verification

LOYALTY_CARD = Loyalty Card

SHIPPING_COSTS_EXPRESS = Shipping costs (express)

FREE_ARTICLE = Free article

GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

SERVICE_CHARGE = Service Charge

CASH_ON_DELIVERY = Cash on delivery

MARKETPLACE_PROVISION = Marketplace-Provision

SUBSCRIPTION_ORDER = Subscription Order

DISCOUNT = Discount

SHIPPING_COSTS = Shipping costs

DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

EventToken

a2

M

Abbreviation of the action to be done: <BT> for Invoice Creation

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

Unique reference number for the enquiry, for example the order number

CodeExt

n..10

O

Error code from Riverty

ErrorText

ans..256

O

Error text from Riverty

ReferenzID

n..50

O

Unique ID within information/response from Riverty

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

InvoiceNr

ns..30

M

Unique reference number for the enquiry, for example the order number

EventToken

a2

M

Abbreviation of the action to be done:

<OS> for canceling the order

<CR> for Credit

Reason

a2

M

Cancellation:

"OUT_OF_STOCK",

"CUSTOMER_CANCELLATION",

"NO_PAYMENT",

"CUSTOMER_SERVICE"

Credit:

CARRIER_RETURN = carrier return

CUSTOMER_RETURN = customer return - use this one if not provided by merchant

Date

date

M

YYYY-MM-DD

reference

ans..32

M

Mandatory for credit, Reference for return

ReturnDate

date

M

Mandatory for credit, Date of return

Articlelist

string

M

Base64 encoded value

items

array

M

Array of items, e.g.: {"items": [{items1 ...}{item2...}]}

items.itemReference

ans..30

M

Position of the line item in the order

items.id

ans..30

M

Article Number

items.description

ans..30

M

Name / Title of the Article

items.quantity

ans..30

M

Total number of items

items.amount

n..10

M

Gross unit price (incl. VAT) in Cent

items.vatAmount

n..10

M

Tax Amount in cents

items.vatPercent

n..10

M

Tax rate of country tax in % as number 19% = 19

items.vatType

string

M

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionType

string

M

SALES_ARTICLE = Sales Article

IBAN_VERIFICATION = IBAN verification

LOYALTY_CARD = Loyalty Card

SHIPPING_COSTS_EXPRESS = Shipping costs (express)

FREE_ARTICLE = Free article

GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

SERVICE_CHARGE = Service Charge

CASH_ON_DELIVERY = Cash on delivery

MARKETPLACE_PROVISION = Marketplace-Provision

SUBSCRIPTION_ORDER = Subscription Order

DISCOUNT = Discount

SHIPPING_COSTS = Shipping costs

DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

Unique reference number for the enquiry, for example the order number

CodeExt

n..10

O

Error code from Riverty

ErrorText

ans..256

O

Error text from Riverty

ReferenzID

n..50

O

Unique ID within information/response from Riverty