1.4.4. Money Transfer batch API

Transfers in batch

Make transfer in batch

Request

HTTP Request

POST https://${hostname}/paynet/api/v3/batch/transfer/{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)
amountCentis int amount
currency string(3)  
sender.name string(1-25)  
sender.address.street string(1-50)  
sender.address.city string(1-25)  
sender.address.state string(2) Must be filled if address is filled and country has states
sender.address.postcodeZip string(1-10)  
sender.address.country string(3)  

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

Request

HTTP Request

POST https://${hostname}/paynet/api/v3/batch/transfer-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
  • Payment detail record
  • Error detail record
  • Unprocessed data record
Header record

Header record contains the following fields:

Property name Value Description
recordType string TH
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
Payment detail record

Payment detail record contains the following fields:

Property name Value Description
recordType string TR
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
transactionCount int number of transactions associated with thisd
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 TE
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 TU
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