LogoLogo
PayShield - Order Insight / TxFind
PayShield - Order Insight / TxFind
  • Overview
    • Overview
  • Integration
    • Integration Overview
    • Merchant Integration
    • Provider Integration
  • Provider
    • Verifi Provider Search
    • EMS Provider Search
  • Merchant
    • Store Transaction Details
    • Update Transaction Details
    • Validate Cart Details
    • Upload Transaction Batch
    • Upload Transaction Batch File
    • Get Merchant Descriptors
  • Cart
    • cart Flag alert received
    • cart Flag chargeback received
    • get all cart attachment data and related meta data
Powered by GitBook
On this page
Edit on GitHub
  1. Merchant

Upload Transaction Batch File

PreviousUpload Transaction BatchNextGet Merchant Descriptors

Last updated 20 days ago

POST https://{base_url}/v2/merchant/{merchantId}/transactionBatch

The Request Body must include a file namedtransactionsFile, which contains a batch of transaction details. The file should be in JSON format, with each entry representing a single transaction.

This endpoint is used to upload and validate a batch of transactions for a specified merchant. It performs general validation and mandatory field checks on the transaction data. If all validations pass, a success message is returned. Otherwise, detailed error messages are provided for any validation failures.

Headers

Name
Value

Content-Type

multipart/form-data

Authorization

Bearer <token>

Path Parameters

Name
Description

merchantId

Merchant Id for transaction batch file upload

Body

Name
Type
Required
Description

transactionsFile

File

True

A file that contains transactions

NOTE: The JSON file data structure inside will be the same as Upload Transaction Batch

  • Headers
  • Path Parameters
  • Body
  • POSTUpload Transaction Batch File

Upload Transaction Batch File

post

Upload a file containing a batch of merchant transactions

Authorizations
Path parameters
merchantIdstringRequired

Merchant Id for transaction batch file upload

Body
transactionsFilestring ยท binaryOptional
Responses
200
Successful Response
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /api/v2/merchant/{merchantId}/transactionBatch HTTP/1.1
Host: {baseurl}
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 29

{
  "transactionsFile": "binary"
}
{
  "msg": "Transactions processed",
  "results": [
    {
      "status": "success",
      "msg": "text"
    }
  ]
}