Direct collect parameters
Payment parametersThe following system parameters can (or must) be used in the mapping to create a valid direct collect request:
- = not allowed (must be left empty)
X = mandatory
O = mandatory with rules
| OUTPUT NAME | DESCRIPTION | FORMAT | MANDATORY | COMMENTS |
|---|---|---|---|---|
| *DirectCollectContract | The name of the contract that must be used for this request | String (name of the contract) | x | |
| *ContractNumber | The number of the direct collect contract under which it is known at the direct collector | String | x | This is mostly the reference under which the mandate is created, i.e. the mandate number |
| *OrderId | The unique number for this direct collect for this customer | String | x | |
| *Description | A description (the reason) for this direct collect | String | x | For instance: monthly rent for September |
| *CurrencyCode | The currency of the amount | XXX (i.e. EUR, USD) | If empty: entity currency is used | |
| *Amount | The total amount to pay | Decimal (xx,xx or xx.xx) | x | |
| *CollectDate | The date when the amount must be collected | Date | If empty: the amount is collected immediately (within 24 hours) | |
| The next items are only necessary if you want the system to create a payment link automatically when the direct collect fails because of an error or when the customer started a reverse charge to return the collected amount. | ||||
| *CreatePaymentOnFailure | Used to indicate if a payment link must be created after a reversed charge or an error | true/false | Default: false | |
| *PaymentMethodCodes | A list of allowed payment method codes for this payment, separated with #. See further chapter Payment method codes for a list of allowed codes | <CODE1>#<CODE2>#... Ie: IDEAL#VISA#MASTERCARD#BANCONTACT | If empty: the default enabled payment methods on entity level are used. Only payment methods that are enabled on entity level can be supplied. | |
| *PspPaymentMethod | The payment method that was used on a successful payment at the PSP (ie: iDEAL, VISA, etc.) | |||
| *PspPaymentMethodCode | The code of the payment method that was used for a successful payment at the PSP (ie: IDEAL, VISA, etc.) | |||
| *ExpirationDateTime | The moment when a payment expires. If left empty, the default expiration is calculated using the info on the 'Payment info' tab of the entity settings | Date | Either the parameter *ExpirationDateTime or *RelativeExpirationHours can be entered. If both left empty, the default expiration date is calculated based on the date that the payment is created after the reverse charge occurred. | |
| *RelativeExpirationHours | The amount of hours AFTER the payment has been created that indicates when a payment expires. If left empty, the default expiration is calculated using the info on the 'Payment info' tab of the entity settings | Number | Either the parameter *ExpirationDateTime or *RelativeExpirationHours can be entered. If both left empty, the default expiration date is calculated based on the date that the payment is created after the reverse charge occurred. | |
| *LanguageCode | The payment language | xx-XX (ie: en-US) | If empty: entity language is used | |
| *Gender | Gender of the client | Char (M, F or U) | If empty: U (unknown) is used | |
| *FirstName | The first name of the client | String | x | |
| *LastName | The last name of the client | String | x | |
| *CompanyName | Company name | String | ||
| *MailAddress | Mail address | String (xx@xx.xx) | o | Only mandatory when SendType is mail |
| *MailAddressesCC | Mail address(es) in the CC (; separated) | String (xx@xx.xx); (yy@yy.yy) | o | Only interesting when SendType is mail |
| *PhoneNumber | (Mobile) phone number | String | o | Only mandatory when SendType is sms |
| *SendType | Indicates via what medium a payment link must be sent | mail, sms or nosend | Only mandatory when CreatePaymentOnFailure is true | |
| *MailTemplate | The name of the mail template that must be used (when *SendType is mail) | String (name of the mail template) | If empty and *SendType is mail: the default mail template is used | |
| *MessageTemplate | The name of the message template that must be used (when *SendType is sms) | String (name of the message template) | If empty and *SendType is sms: default message template is used | |
| *AcceptUrl | The URL to which the customer is directed after a successful transaction. | Available to automated external calls when creating a direct collect. | ||
| *DeclineUrl | The URL to which the customer is directed after a rejected transaction. | Available to automated external calls when creating a direct collect. | ||
| *ErrorUrl | The URL to which the customer is directed when an error occurs. | Available to automated external calls when creating a direct collect. | ||
| *FailUrl | The URL to which the customer is directed when the transaction failed or the user clicked on 'cancel'. | Available to automated external calls when creating a direct collect. | ||
| *HomeUrl | The URL to which the customer is directed when he clicks on 'home'. | Available to automated external calls when creating a direct collect. | ||
Date updated: 2022-03-28
