Send a batch transaction

POST /api/transaction

Use this call to send a batch transaction. A sample request and response is below.

Request URL

https:// .../batch/api/transaction

Request attributes

Attribute

Description

BatchId
string

Unique identifier for the batch.
Required

RequestId
GUID

Unique customer generated transaction request identifier. This parameter corresponds to the TransacationRequestId in the response.
Required

CardToken
string

Token for the signed-up debit card.
Required

Amount
integer

Transaction amount in cents.
Required

SourceSenderName
string

Submerchant name.
Required

SourceMcc
string

A 4-digit number that credit card networks assign to businesses to denote the type of business or service it is in.
Required

Sample request POST /api/transaction

{
   "BatchId":"00000000-0000-0000-0000-000000000000",
   "PushToCardRequests":[
      {
         "RequestId":"00000000-0000-0000-0000-000000000000",
         "CardToken":"string",
         "Amount":10,
         "SourceSenderName":"string",
         "SourceMcc":"string"
      }
   ]
}

Response attributes

Attribute

Description

transactionRequestId
GUID

Unique customer generated transaction identifier.
This parameter corresponds to the RequestId in the response.

amount
integer

Transaction amount in cents.

transactionRequestedAt
string

Date and time the transaction was requested.

transactionStatus
string

Status of the transaction:

  • Pending
  • Approved
  • Failed
  • Rejected

errorDescription
string

Description of any error that might have occurred.

creditCardId
string

Card token of the debit card that was transacted to.

railId
string

The processor used to perform the transaction.

  • RS2
  • McSend
  • TabaPay

network
string

Card network.

  • Visa
  • Mastercard
  • ET
  • PULSE
  • STAR
  • NYCE
  • Accel
  • RPPS
  • MoneySend

retrievalReferenceId
GUID

Unique tracking identifier for this transaction in the processors to correlate this transaction to the processors.

actualTransactionDoneAt
string

Actual time the transaction was sent to the processor.

paymentSent
boolean

True if the payment was sent, otherwise false.

requestApproved
boolean

True if the payment passed all the way to the processor successfully, otherwise false.

responseReceived
boolean

True if P2P received a response from the external processor, otherwise false.

responseCode
integer

An ISO 8583 two-digit code signifying the transaction result. For example, 00 means successful.

responseDescription
string

An ISO 8583 string description of the transaction result. For example, Approved.

traceNumber
string

Unique number that is assigned to a transaction when it leaves the merchant bank until it arrives at the cardholder bank.

error
string

Descriptive error, if relevant.

transactionRequestBatchId
GUID

Batch ID for the transaction request.

sourceSenderName
string

Submerchant name.

sourceMcc
integer

Merchant Category Code (MCC).
4-digits that a credit card issuer uses to categorize consumer transactions for their card.

isSuccessfull
boolean

True if the transaction was sent successfully, otherwise false.

Sample response

{
   "result":{
      "transactionRequestId":"00000000-0128-0000-0000-000000000000",
      "amount":10,
      "transactionRequestedAt":"2021-01-24T13:59:33.3589159Z",
      "transactionStatus":"Succeeded",
      "errorDescription":null,
      "creditCardId":"ELHPIE39WGWYDVYAT280YBS138F1YLA0NSV5E2",
      "railId":"McSend",
      "network":"MasterCard",
      "retrievalReferenceId":"a0d77e03-6f34-4ff5-b215-e63a8dc5dfe2",
      "actualTransactionDoneAt":"2021-01-24T13:59:34.1566161Z",
      "paymentSent":true,
      "requestApproved":true,
      "responseReceived":true,
      "responseCode":"00",
      "responseDescription":"Approved",
      "traceNumber":"00000000-0128-0000-0000-000000000000",
      "error":null,
      "transactionRequestBatchId":null,
      "sourceSenderName":"ABCD",
      "sourceMcc":"1234"
   }
   "isSuccessfull":true
}"

Did this page help you?