API Overview

Account Updater
- Recent Revisions to This Document

Introduction to Account Updater
- Tokenization
  - Token Harvest Updates
  - Token Selective Batch Updates
- Storing PANs
- Enabling Account Updater
  - Smartpay Fuse Portal Permissions
- Terms of Use

Token Updates
- Token Harvest
- Token Batch Updates
  - Submitting Visa and Mastercard One-Time Updates
  - Registering Tokens for American Express Daily Updates
  - Batch Creation Request Examples
  - Batch Creation Response Examples
  - Retrieving Batch Status
    - Visa and Mastercard One-Time Updates
    - One-Time Batch Update Response
    - Customer Token Batch Report Responses
  - American Express Daily and Token Harvest Update Reports
  - Retrieving a Batch with a Batch ID
  - American Express Daily Updates

PAN Updates
- Creating Security Keys
  - Authentication Key
  - PGP Public/Private Key
- Formatting a Request File
  - Request Header Record
  - Request Detail Record
  - Request Footer Record
  - Request File Examples
- Uploading a Request File
- Email Notification
- Viewing the Status of a Batch File
- Downloading a Response File
- Response File Records
  - Response Header Record
  - Response Detail Record
  - Response Footer Record
  - Response File Examples

Testing
- American Express Test Card Numbers
- Mastercard Test Card Numbers
- Visa Test Card Numbers

API Fields
- Request Fields
- Response Fields

PAN Upload Response Codes and Reason Codes

On This Page

Request Header Record

The header record consists of comma-separated values and uses the fields listed in the following table:

Header Record Fields
Field Name	Description	Required or Optional	Data Type & Length
Record Identifier	Constant value indicating the record type. Format: H	Required	Alpha (1)
File Classification	Indicates whether this is a request or response file. Format: cybs.au.request.pan	Required	Alpha (30)
merchantID	Your merchant ID. Format: sampleID2	Required	Alphanumeric (30)
batchID	File (batch) identifier that you assign. The batch ID must be unique. If you send a file that contains a previously submitted batch ID, the file is rejected. Format: 12345	Required	Numeric (30)
recordCount	The number of detail records in the file. Format: 12345	Required	Numeric
statusEmail	Email address to which status emails for the request are sent. Format: [email protected]	Required	Alphanumeric (100)
creationDate	Optional field that you can pass for reference. If present, it appears in the Smartpay Fuse Portal Account Updater View Status window Format: yyyy-MM-DD	Optional	String (10)
Batch Info	Optional field that you can pass for reference. Format: sample12	Optional	Alphanumeric (50)

Back to top