1.4.2. Card mapping batch API¶

Create card mapping batch
- Create card mappings in batch
- Card mapping batch creation status
Update card mapping batch
- Update card mappings in batch
- Card mapping batch updating status
Delete card mapping batch
- Delete card mappings in batch
- Card mapping batch deletion status
Delete subscriber batch
- Delete subscriber IDs in batch
- Subscriber batch deletion status

Create card mapping batch ¶

Create card mappings in batch ¶

Creates card mappings supplied via batch file.

Card mapping is given an alias (or name).

Card mapping is created for sending, receiving or both sending and receiving funds.

Batch file format ¶

Batch file format

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/create/{endpointId}/{clientOrderId}

Request body

In the batch file, supply records consisting of the following fields:

Property name	Value	Description
clientOrderId	string(1-36)
ica	string(4-6)
subscriberType	enum
subscriberId	string(1-99)
accountUsage	enum	Possible values: SENDING, RECEIVING, SEND_RECV
alias	string(1-20)	Alias of the created mapping
defaultIndicator	boolean
card.number	string(9-19)	the card number (PAN)
card.expiry.month	integer(2)
card.expiry.year	integer(4)
card.holder.firstName	string(1-50)
card.holder.middleInitial	string(1)
card.holder.lastName	string(1-50)
address.street	string(1-50)
address.street2	string(1-50)
address.city	string(1-100)
address.state	string(2)	State code. Required if country has states
address.postcodeZip	string(1-10)
address.country	string(3)	ISO 3166-1 alpha-3 code
dateOfBirth	string(8)	The cardholder’s birth day in format “YYYYMMDD”

Response ¶

If successful, this method returns the following response body:

{
  "clientOrderId": {string},
  "paynetOrderId": {long},
  "sessionToken": {string},
  "requestSerialNumber": {string}
}

Property name	Value	Description
clientOrderId	string	order identifier assigned by the caller
paynetOrderId	string	order identifier assigned by the server
sessionToken	string	the session token which is to be used when calling Card mapping batch creation status

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Card mapping batch creation status ¶

Making requests ¶

Making requests to V3 API

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/create-status/{endpointId}/{clientOrderId}

Request body

In the request body, supply data with the following structure:

{
  "sessionToken": {string}
}

Property name	Value	Description
Required properties
sessionToken	string(16-36)	the session token of card mapping transaction

Response ¶

If successful, this method returns batch file in CSV format. That file may contain records of the following formats:

Header record
Card mapping creation result record
Error detail record
Unprocessed data record

Header record ¶

Header record contains the following fields:

Property name	Value	Description
recordType	string	MCH
status	enum	`ACCEPTED`, `DECLINED`
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`

Card mapping creation result record ¶

Card mapping creation result record record contains the following fields:

Property name	Value	Description
recordType	string	MCR
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
bankOrderId	string
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`, `FILTERED`, `ERROR`, `UNKNOWN`
mappingId	long	Mapping ID
errorCount	int	number of errors associated with this record

Error detail record ¶

Error detail record contains the following fields:

Property name	Value	Description
recordType	string	MCE
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
errorRecordNumber	int	Number of error record for causing record
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)

Unprocessed data record ¶

Unprocessed data record contains the following fields:

Property name	Value	Description
recordType	string	MCU
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
reasonCode	enum	`UNRECOGNIZED`, `CRITICAL_ERROR`, `REQUEST_REJECTION_THRESHOLD`

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Update card mapping batch ¶

Update card mappings in batch ¶

Updates card mappings supplied via batch file.

Batch file format ¶

Batch file format

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/update/{endpointId}/{clientOrderId}

Request body

In the batch file, supply records consisting of the following fields:

Property name	Value	Description
clientOrderId	string(1-36)
mappingId	long
subscriberType	enum
subscriberId	string(1-99)
currentAccountUsage	enum	Possible values: SENDING, RECEIVING, SEND_RECV
currentAlias	string(1-20)	Alias of the mapping to be updated
newAccountUsage	enum	Possible values: SENDING, RECEIVING, SEND_RECV
newAlias	string(1-20)	Alias to assign to the mapping
defaultIndicator	boolean
card.number	string(9-19)	the card number (PAN)
card.expiry.month	integer(2)
card.expiry.year	integer(4)
card.holder.firstName	string(1-50)
card.holder.middleInitial	string(1)
card.holder.lastName	string(1-50)
address.street	string(1-50)
address.street2	string(1-50)
address.city	string(1-100)
address.state	string(2)	State code. Required if country has states
address.postcodeZip	string(1-10)
address.country	string(3)	ISO 3166-1 alpha-3 code
dateOfBirth	string(8)	The cardholder’s birth day in format “YYYYMMDD”

Response ¶

If successful, this method returns the following response body:

{
  "clientOrderId": {string},
  "paynetOrderId": {long},
  "sessionToken": {string},
  "requestSerialNumber": {string}
}

Property name	Value	Description
clientOrderId	string	order identifier assigned by the caller
paynetOrderId	string	order identifier assigned by the server
sessionToken	string	the session token which is to be used when calling Card mapping batch updating status

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Card mapping batch updating status ¶

Making requests ¶

Making requests to V3 API

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/update-status/{endpointId}/{clientOrderId}

Request body

In the request body, supply data with the following structure:

{
  "sessionToken": {string}
}

Property name	Value	Description
Required properties
sessionToken	string(16-36)	the session token of card mapping transaction

Response ¶

If successful, this method returns batch file in CSV format. That file may contain records of the following formats:

Header record
Card mapping updating result record
Error detail record
Unprocessed data record

Header record ¶

Header record contains the following fields:

Property name	Value	Description
recordType	string	MUH
status	enum	`ACCEPTED`, `DECLINED`
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`

Card mapping updating result record ¶

Card mapping updating result record record contains the following fields:

Property name	Value	Description
recordType	string	MUR
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
bankOrderId	string
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`, `FILTERED`, `ERROR`, `UNKNOWN`
mappingId	long	Mapping ID
errorCount	int	number of errors associated with this record

Error detail record ¶

Error detail record contains the following fields:

Property name	Value	Description
recordType	string	MUE
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
errorRecordNumber	int	Number of error record for causing record
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)

Unprocessed data record ¶

Unprocessed data record contains the following fields:

Property name	Value	Description
recordType	string	MUU
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
reasonCode	enum	`UNRECOGNIZED`, `CRITICAL_ERROR`, `REQUEST_REJECTION_THRESHOLD`

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Delete card mapping batch ¶

Delete card mappings in batch ¶

Deletes card mappings supplied via batch file.

Batch file format ¶

Batch file format

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/delete/{endpointId}/{clientOrderId}

Request body

In the batch file, supply records consisting of the following fields:

Property name	Value	Description
clientOrderId	string(1-36)
mappingId	long
subscriberType	enum
subscriberId	string(1-99)
accountUsage	enum	Possible values: SENDING, RECEIVING, SEND_RECV
alias	string(1-20)	Alias of the created mapping

Response ¶

If successful, this method returns the following response body:

{
  "clientOrderId": {string},
  "paynetOrderId": {long},
  "sessionToken": {string},
  "requestSerialNumber": {string}
}

Property name	Value	Description
clientOrderId	string	order identifier assigned by the caller
paynetOrderId	string	order identifier assigned by the server
sessionToken	string	the session token which is to be used when calling Card mapping batch deletion status

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Card mapping batch deletion status ¶

Making requests ¶

Making requests to V3 API

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/delete-status/{endpointId}/{clientOrderId}

Request body

In the request body, supply data with the following structure:

{
  "sessionToken": {string}
}

Property name	Value	Description
Required properties
sessionToken	string(16-36)	the session token of card mapping transaction

Response ¶

If successful, this method returns batch file in CSV format. That file may contain records of the following formats:

Header record
Card mapping deletion result record
Error detail record
Unprocessed data record

Header record ¶

Header record contains the following fields:

Property name	Value	Description
recordType	string	MDH
status	enum	`ACCEPTED`, `DECLINED`
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`

Card mapping deletion result record ¶

Card mapping deletion result record record contains the following fields:

Property name	Value	Description
recordType	string	MDR
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
bankOrderId	string
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`, `FILTERED`, `ERROR`, `UNKNOWN`
mappingId	long	Mapping ID
errorCount	int	number of errors associated with this record

Error detail record ¶

Error detail record contains the following fields:

Property name	Value	Description
recordType	string	MDE
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
errorRecordNumber	int	Number of error record for causing record
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)

Unprocessed data record ¶

Unprocessed data record contains the following fields:

Property name	Value	Description
recordType	string	MDU
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
reasonCode	enum	`UNRECOGNIZED`, `CRITICAL_ERROR`, `REQUEST_REJECTION_THRESHOLD`

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Delete subscriber batch ¶

Delete subscriber IDs in batch ¶

Deletes subscriber IDs supplied via batch file.

Batch file format ¶

Batch file format

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/delete-subscriber-id/{endpointId}/{clientOrderId}

Request body

In the batch file, supply records consisting of the following fields:

Property name	Value	Description
clientOrderId	string(1-36)
subscriberType	enum
subscriberId	string(1-99)

Response ¶

If successful, this method returns the following response body:

{
  "clientOrderId": {string},
  "paynetOrderId": {long},
  "sessionToken": {string},
  "requestSerialNumber": {string}
}

Property name	Value	Description
clientOrderId	string	order identifier assigned by the caller
paynetOrderId	string	order identifier assigned by the server
sessionToken	string	the session token which is to be used when calling Subscriber batch deletion status

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Subscriber batch deletion status ¶

Making requests ¶

Making requests to V3 API

Request ¶

HTTP Request

POST https://${hostname}/paynet/api/v3/card-mapping/batch/delete-subscriber-status/{endpointId}/{clientOrderId}

Request body

In the request body, supply data with the following structure:

{
  "sessionToken": {string}
}

Property name	Value	Description
Required properties
sessionToken	string(16-36)	the session token of card mapping transaction

Response ¶

If successful, this method returns batch file in CSV format. That file may contain records of the following formats:

Header record
Subscriber deletion result record
Error detail record
Unprocessed data record

Header record ¶

Header record contains the following fields:

Property name	Value	Description
recordType	string	MSH
status	enum	`ACCEPTED`, `DECLINED`
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`

Subscriber deletion result record ¶

Subscriber deletion result record record contains the following fields:

Property name	Value	Description
recordType	string	MSR
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
bankOrderId	string
state	enum	possible values: `PROCESSING`, `REDIRECT_REQUEST`, `APPROVED`, `DECLINED`, `FILTERED`, `ERROR`, `UNKNOWN`
errorCount	int	number of errors associated with this record

Error detail record ¶

Error detail record contains the following fields:

Property name	Value	Description
recordType	string	MSE
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
errorRecordNumber	int	Number of error record for causing record
errorCode	int	error code (in case of error)
errorMessage	string(256)	error message (in case of error)

Unprocessed data record ¶

Unprocessed data record contains the following fields:

Property name	Value	Description
recordType	string	MSU
batchRecordNumber	int	Number of record in the initial batch file
clientOrderId	string
reasonCode	enum	`UNRECOGNIZED`, `CRITICAL_ERROR`, `REQUEST_REJECTION_THRESHOLD`

In case of a failure, this method returns the following response body:

{
  "error": {
    "code": {string},
    "message": {string}
  },
  "clientOrderId": {string}
}

Property name	Value	Description
error	object
error.code	string	the error code
error.message	string	the description of the error
clientOrderId	string	order identifier assigned by the caller

Quick search

1.4.2. Card mapping batch API¶