Acknowledgement Report Specification (Open Wallet API)

DOCS

Last updated: Aug 15th, 8:07am

This report describes the acknowledgements by submission file.

File specifications

The following specifications apply to the Acknowledgement report file:

Record length2000 byte fixed length.
File formatUTF-8 encoded.
Transmission day and timeDay of the transaction before 3 AM PST.
File directionIn general, transmitted from partner to PayPal.

Field specifications

The following specifications apply to the fields in the Acknowledgement report:

PositionFieldTypeLength;
Start and end positions
ValueRequired?Description
1CLIENT_IDAlphanumeric, uppercase, left justified, character space filled (if no value)11
1 and 11
N/AYesUnique PayPal-assigned ID to the client.
2FILE_DIRECTIONAlphanumeric, uppercase, left justified, character space filled (if no value)1
12 and 12
--YesDirection that the submission file is sent:
  • 1. PayPal to client.
  • 2. Client to PayPal.
| | 3 | `FILE_REFERENCE_NUMBER` | Alphanumeric, uppercase, left justified, character space filled (if no value) | 12
13 and 24 | System-generated file reference number. Unique across PayPal. Echo back from submission file. | Yes | Contains a submitter-specified file reference number that can be used to track this file. Value should be unique for each file submitted. Use the value in this field is as a file identification and cross-reference to the corresponding file validation report. | | 4 | `FILE_CREATION_DATE` | Numeric, `CCYYMMDD` | 8
25 and 32 | The date when the submission file was created (PST). Echo back from submission file. | Yes | Corresponds to the date when the submitter created the file. The format is `CCYYMMDD`, where:
  • CC. Century.
  • YY. Year.
  • MM. Month.
  • DD. Day.
For example, enter `20200215` for February 15, 2020. | | 5 | `FILE_CREATION_TIME` | Numeric, `HHMMSS` (24-hour clock) | 6
33 and 38 | The time when the submission file was created (PST). Echo back from submission file. | Yes | Corresponds to the time when the submitter created the file. The format is `HHMMSS`, where:
  • HH. Hour (24-hour clock)
  • MM. Minute.
  • SS. Second.
For example, enter `143000` for 2:30 PM. | | 6 | `SUBMISSION_FILE_TRACKING_NUMBER` | Alphanumeric, uppercase, left justified, character space filled (if no value) | 12
39 and 50 | Unique ID to track the submission file from client. | Yes | -- | | 7 | `FILLER` | Alphanumeric | 1950
51 and 2000 | Character spaces | Yes | Reserved for PayPal internal use. |