Content
Files contain several types of information:
It can be generated for all customers who subscribe to that option, regardless of the delivery format used vis-à-vis the acquirer:
The delivery file is generated from the contents of the Payline information system.
The reconciliation data (bank and unpaid commissions) are generated from two bank files:
Note that the discount image file that will be sent to J will contain J-2 data.
The format of the file generation is, according to your choice, of the XML type in UTF8 encoding or of the CSV type in ASCII encoding.
The name of the file will have the following naming "Discount_yyyyymymdd".
Such a file can be processed by programs, but also manually. Indeed, the XML format can be viewed by an Internet browser and the CSV format by the Excel application.
In the case of the XML format, tags located at different hierarchical levels provide a variable level of synthesis:
In the case of the CSV format, you have the choice of the file structure:
A file is generated every day, whether there are transactions or not. The provided sequence number guarantees the sequence of these files.
Files can be made available in the morning (from 7am)
The discount image file can be sent to the customer by:
The diffusion by CFT, SFTP, FTPS is done automatically to a server of the client.
This section describes the format of the CSV delivery image files. This format is very useful for updating your information system. You can also view this file by opening it in Excel.
The structure of the CSV file is standard:
Optionally, it is possible to generate the CSV file with the following format:
As standard , the header line contains the following data:
1 | Type;MerchantName;MerchantID;PointOfSellName;PaymentTypeCode;AcquierName;ContractNumber;ContractDescription;CurrencyCode;OrderReference;OrderDescription;TransactionID;AcquierTransactionReference;OperationTypeCode;CaptureFileDate;AuthorizationNumber;AuthorizationAmount;AuthorizationCurrencyCode;AuthorizationDate;AuthorizationOrigin;Pan;3dsecure;AVS;CaptureDate;CaptureOrigin;CaptureAmount;FileNumber;OperationTypeCode;SettleDate;GrossAmount;FeeAmount;ChargeBackDate;ChargeBackAmount;ChargeBackReason;ChargeBackDescription |
Optionally, it is possible to generate a header line that will have the following format
Column name | No collar | Type | Max | Format | Value or description |
---|---|---|---|---|---|
type | 1 | R | 6 | A | Type of line: HEADER |
name | 2 | R | 100 | AN | File name |
dated | 3 | R | 20 | AN | Local timestamp of the file in YYYY / MM / DD format HH: MM: SS |
version | 4 | R | 10 | AN | File version. (For example: 4.0.1) |
sequence | 5 | R | 6 | NOT | Sequential file number incremented from 1 to each file |
Legend: R = required, F = optional, C = conditional
Column name | No collar | Type | Max | Format | Option | Value or description |
---|---|---|---|---|---|---|
Type | 1 | R | 6 | A | Line type: LINE if reconciliation not requested, CAP, SET, CBK, REJ. | |
merchantName | 2 | R | 100 | AN | Tradesman's sign | |
merchantID | 3 | R | 14 | NOT | Merchant ID | |
PointOfSellName | 4 | R | 50 | AN | Title of the sign | |
paymentTypeCode | 5 | R | 20 | AN | Code of the associated method of payment | |
acquierName | 6 | R | 30 | NOT | Name of the acquirer of the merchant | |
contractNumber | 7 | R | 50 | AN | Accepted merchant contract number | |
contractDescription | 8 | R | 30 | AN | Title of the contract | |
currencyCode | 9 | R | 3 | NOT | Main currency | |
Reference orders | 10 | R | 50 | AN | 1 | Order reference |
orderDescription | 11 | F | 60 | AN | 1 | Description of the order |
transactionID | 12 | R | 50 | AN | 1 | ID of the initial authorization transaction generated by Payline |
acquierTransactionReference | 13 | C | 12 | AN | 1 | Archiving reference generated from the order reference and respecting the format constraints of the purchaser. |
Fields valued only if type = CAP or LINE | ||||||
operationTypeCode | 14 | C | 1 | A | 1 | Operation code D for flow or C for credit (this column is also used for CBK) |
captureFileDate | 15 | C | 25 | AN | 1 | Date of delivery |
authorizationNumber | 16 | C | 6 | AN | 1 | Authorization number |
authorizationAmount | 17 | C | 12 | NOT | 1 | Amount of authorization |
authorizationCurrencyCode | 18 | C | 3 | NOT | 1 | Currency of authorization |
authorizationDate | 19 | C | 25 | AN | 1 | Date of the authorization transaction |
authorizationOrigin | 20 | C | 50 | AN | 1 | Origin of the authorization transaction |
Pan | 21 | C | 19 | NOT | 1 | Masked card number according to PCI / DSS rules |
3DSecure | 22 | C | 1 | NOT | 1 | Secured by 3DSecure 0 = no and 1 = yes |
AVS | 23 | C | 1 | NOT | 1 | Securing by postal address verification AVS 0 = no and 1 = yes |
captureDate | 24 | C | 25 | AN | 1 | Date of the validation transaction |
captureOrigin | 25 | C | 50 | AN | 1 | Origin of the validation transaction |
captureAmount | 26 | C | 12 | NOT | 1 | Gross amount of discount (before deduction of commissions) |
FileNumber | 27 | C | 50 | NOT | 2 | Discount batch number. Present only if the "FileNumber" option is requested. |
Valued fields only if type = SET and | ||||||
operationTypeCode | 28 | C | 1 | A | 1 | Operation code D for debit or C for credit |
settleDate | 29 | C | 25 | AN | 1 | Date of reconciliation |
grossAmount | 30 | C | 12 | NOT | 1 | Gross amount of the transaction |
feeAmount | 31 | C | 12 | NOT | 1 | Commission on the transaction |
IFR | 32 | C | 16 | NOT | 3 | Amount of IFR interchange. |
Fields valued only if type = CBK and reconciliation option requested (see chapter 6) | ||||||
chargebackDate | 33 | C | 25 | A | 1 | Date of the unpaid |
chargebackAmount | 34 | C | 12 | AN | 1 | Amount of unpaid |
chargebackReason | 35 | C | 20 | AN | 1 | Code of unpaid |
chargebackDescription | 36 | C | 100 | AN | 1 | The description of the unpaid is limited to 100 characters |
chargebackNumber | 37 | C | 16 | AN | 4 | File number attached to the unpaid. Only present if the "load_back_number" option is requested |
Fields valued only if type = REJ and specific contract * (see list ) | ||||||
rejectDate | R | 20 | NOT | Date of rejection | ||
rejectAmount | R | 12 | AN | Amount of rejection | ||
rejectReason | C | 20 | AN | Rejection code | ||
rejectDescription | C | 100 | AN | Description of truncated rejection over 100 characters |
Legend: R = required, F = optional, C = conditional
* Specific contract = This function is not supported by all means of payment and acquirer.
In standard version, this line does not exist.
Optionally, it is possible to generate a tail line that will have this format
Column name | No collar | Type | Max | Format | Value or description |
---|---|---|---|---|---|
Type | 1 | R | 6 | A | Type of line: FOOTER |
captureNumber | 2 | R | 8 | NOT | Total number of transactions delivered to the file |
settlementNumber | 3 | R | 8 | NOT | Total number of transactions reconciled in the file |
chargebackNumber | 4 | R | 8 | NOT | Total number of unpaid transactions in the file |
Legend: R = required, F = optional, C = conditional
Bank commission data is conditioned by the provision of information by the financial institution and the subscription of this option to Payline.
The archiving reference ( acquierTransactionReference ) is by default the first x characters of the order reference communicated by the merchant in the authorization request. Depending on the constraints of the acquirers, x varies between 10 and 12 characters. Non-strictly alphanumeric characters (other than [az] [AZ] [0-9]) are removed from the command reference before truncation to x characters.
Optionally, Payline can apply a rule that allows to deduce the order reference from the archive reference. Thus, the reconciliation between the transaction stored and the order at the merchant is facilitated.
In case you do not subscribe to the option "Bank reconciliation", available in the management of your subscription from the administration center, you will have access only (in the XML and CSV files) to the nominal tree of the file delivery image that is to say the elements of type "CAPTURE" (Cf. 3 .5)
In case the merchant has subscribed to the option "bank reconciliation", he will also have access to the tree containing the "SETTLEMENT" and "CHARGEBACK" elements in the XML file. For the CSV file, the transaction lines may contain elements of the type "SET" and "CBK".
The number of the delivery lot will be returned by the purchaser. This option must be requested when setting up the file.
If the option is not requested, then the following information will be advanced by one position.
The amount of the interchange will be returned by the purchaser. This option must be requested when setting up the file.
If the option is not requested, then the following information will be advanced by one position.
The amount of the interchange will be returned by the purchaser. This option must be requested when setting up the file.
If the option is not requested, then the following information will be advanced by one position.
The catches and settlements are in the same direction:
CAPTURE | SETTLEMENT | |
---|---|---|
Payment | C | C |
Refund | D | D |
operations | Transaction file | Payment file | Debit / credit |
---|---|---|---|
Autor (doAutor, action = 100) | Author | - | - |
Autor + Validation (doAutor, action = 101) | Autor (101) Validation | CAP (J + 1) SET (D + 2) | C C |
Validation (doCapture, action = 201) | Validation | CAP (D + 1) | C |
Autor (doAutor, action = 100) Cancel (doReset: before validation) | AutorAnnulation | - | - |
Autor (doAutor, action = 100) Validation (doCapture, action = 201) Refund (doReund, action = 421: after validation) | AuthorValidationRemboursement | CAP (J + 1) SET (D + 2) CAP (D + 2) SET (D + 2) | C CD D |
Autor (doAutor, action = 100) Validation (doCapture, action = 201) Chargeback | AuthorValidationImpayé | CAP (J + 1) SET (D + 2) CBK | C CD |
Flow (doDebit, action = 204: operation not guaranteed) | Debit | CAP (J + 1) SET (D + 2) | C C |
Credit (doCredit, action = 422: unsecured transaction) | Credit | CAP (J + 1) SET (D + 2) | DD |
Order (Paypal order) | |||
Re-authorization (action.202) | Author Author | - | - |
For some means of payment, the fees are presented in the reconciliation file in a line of type SET.
The "Payment List" file contains only accepted transactions sent to the bank to be credited or debited to your bank account.
It will be automatically generated daily and sent by a secure stream.
The commissions charged by the processor are returned in this file.
For example, it will contain:
For all lines: The order reference and the transaction ID will be transmitted in the records. The FileNumber field of the SET message allows the merchant to know the reference of the transfer made by the processor to the merchant. This is the identifier of the form "Vxxxxxxxxxxx" corresponding to the BankingTransactionLabelPattern information received from the processor.
For SET credit transfer validation lines: the feeAmount amount will be zero.
For SET transfer fee lines: The fee amount is shown in the feeAmount field . The AuthorizationAmount and CaptureAmount fields will be null.
idTR | Type | feeAmount | FileNumber | AuthorizationAmount | CaptureAmount |
---|---|---|---|---|---|
123 | CAP | 0 | 0 | 400 | 400 |
123 | SET | 0 | V01 | 100 | 100 |
123 | SET | 0 | V02 | 300 | 300 |
123 | SET | 10 | P01 | 0 | 0 |
123 | SET | 300 | P02 | 0 | 0 |