Get Batch

 

Description

The Get batch call can be used to request data on transactions included to certain settlement batch(es). Netaxept then returns detailed information concerning the batch(es) and its transactions.

 

API call

Test:

Production:

Please note that Server Name Indication (SNI) is required when connecting to Netaxept test environment URL https://test.epayment.nets.eu. Example of the REST Get batch call and the corresponding response can be found in the “Sample code” section.

 

Input parameters

Available input parameters in the GetBatch are listed below. Please see proper validation rules at the “Validation” section.

Authentication

Merchant ID

REST: MerchantId

WebServices: merchantId

Required

Validation: Numeric

MaxLength: 8

Merchant ID is a unique ID generated by Nets for identifying each merchant in Netaxept. You need to send this ID to Netaxept along all API calls. Test accounts may have a maximum length of 8 digits, while production accounts has a maximum length of 6 digits.

 

Token

REST: Token

WebServices: token

Required

Validation: Reference

MaxLength: 32

Token is the shared secret between the merchant and Netaxept. It is used to authenticate the merchant, and is provided to you by Netaxept.

GetTransactionIdsRequest

If batchnumber, fromTimestamp and toTimestamp are all specified, the search will only match the batch(es) satisfying all criteria.

Batch number

REST: BatchNumber

WebServices: BatchNumber

Required [unless fromTimestamp and toTimestamp specified]

Validation: Numeric

MaxLength: 4

Searches settlement batch data for a given batch number, without considering timestamp.

 

From timestamp

REST: fromTimestamp

WebServices: fromTimestamp

Required [unless batchnumber specified]

Validation: Date

MaxLength: 10

Searches batch information from this date, on the format YYYY-MM-DD.

 

To timestamp

REST: ToTimestamp

WebServices: toTimestamp

Required [unless batchnumber specified]

Validation: Date

MaxLength: 10

Searches batch information to this date, on the format YYYY-MM-DD.

 

Output parameters

Available output parameters in the BatchResponse are listed below.

Summary

Total captured

REST: totalCaptured

WebServices: totalCaptured

Required

Validation: Numeric

MaxLength: 10

Aggregated amount captured in the transactions displayed.

 

Total credited

REST: totalCredited

WebServices: totalCredited

Required

Validation: Numeric

MaxLength: 10

Aggregated amount credited in the transactions displayed.

 

Items

This section documents the Items that is an array of BatchResponseItem(s) with one line for each transaction operation (Capture, Credit). To get specific information on these transactions, please run the Query call to the transaction.

Timestamp

REST: Timestamp

WebServices:

Required

Validation: Timestamp

MaxLength: N/A

A timestamp indicating when the operation in question was finished, on the format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ. Timezone is optional. For example: 2010-02-15T14:35:19.305+01:00. This timestamp is generated on the Netaxept server.

 

Issuer

REST: Issuer

WebServices: 

Required

Validation: Alpha

MaxLength: 32

Indicates which payment method was used for this transaction.

 

Operation

REST: Operation

WebServices: 

Required

Validation: Alpha

MaxLength: 7

Specifies which operation was performed for the transaction. Valid operations are:

  • CAPTURE (incl. Sale)
  • CREDIT

Read more about the different operations at the "Flow outline" section.

 

Masked PAN

REST: MaskedPan

WebServices:

Required

Validation: Custom

MaxLength: 19

The card number used for this transaction, masked with asterisks.

 

Amount 

REST: Amount

WebServices: 

Required

Validation: Numeric

MaxLength: 10

The amount of this part of the transaction / operation described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees. For example: 100,00 NOK is noted as "10000" and 9.99 USD is noted as "999".

 

Authorization id

REST: AuthorizationId

WebServices: 

Required

Validation: Custom

MaxLength: 64

An ID given to an authorized transaction by the Issuer.

 

Currency

REST: Currency

WebServices:

Required

Validation: Alpha

MaxLength: 3

The currency code for the transaction amount, following ISO 4217. For example "NOK", "SEK", "DKK", "EUR" and "USD".

 

Batch number

REST: BatchNumber

WebServices: 

Required

Validation: Numeric

MaxLength: 4

Specifies which settlement batch this operation belongs to.

 

Order number

REST: OrderNumber

WebServices: 

Required

Validation: Reference

MaxLength: 32

A transaction identifier defined by the merchant. Nets recommends to generate each transaction a unique order number but if wanted the same order number can be used several times.

 

Transaction id

REST: TransactionId

WebServices:

Required

Validation: Reference

MaxLength: 32

Transaction ID is a unique ID identifying each transaction within the Merchant ID in Netaxept at any point.

 

Transaction reference number

REST: TransactionReconRef

WebServices: 

Required

Validation: Reference

MaxLength: 32

The transaction reconciliation reference is a reference number allocated to the transaction by the merchant. The transaction reference number will be returned to the merchant with the settlement if the chosen acquirer supports the return of the transaction-specific reference number. The transaction reference number can also be seen in the merchant's bank statement when direct bank payments are in question. Read more about transaction reference numbers >

In this parameter you will find the transaction reference number used for this part of the transaction. It can be sent to Netaxept along the Register call when it will serve as a default reference for the transaction. Alternatively, it can be sent in along the Process call.

 

Exceptions and return codes

If something goes wrong when communicating between your system and Netaxept or in the middle of the payment process, Netaxept declines the transaction and returns an exception. All exceptions are wrapped in the outer Exception tag, with an Error tag inside. The type (xsi:type) of the Error tag indicates which exception it is. In most cases, the exception includes the error code indicating the error, as well as an error message explaining the code. Read more about exceptions > and response codes >

  • AuthenticationException
  • GenericError
  • ValidationException