POST payments/credit/postauthorization

Creates post authorization for a credit transaction.

Request Information

URI Parameters

None.

Body Parameters

request payload

CreditPostAuthorizationRequest
NameDescriptionTypeAdditional information
TransactionData

Specific information for the transaction.

CreditPostAuthorizationTransactionData

Required

OriginalTransactionData

Specific information for the original transaction (to be refunded).

CreditPostAuthorizationOriginalTranData

Required

AmountsRequest

Amount requested for this transaction.

CreditPostAuthorizationAmountsRequest

Required

AdditionalData

Contains Additional data for processing a credit authorization.

CreditPostAuthorizationAdditionalData

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionData": {
    "UniqueIdentifier": "sample string 1",
    "TimeStamp": "2024-05-02T17:36:05.804Z",
    "TotalAmount": 3.0,
    "Description": "sample string 4",
    "GeotagInfo": {
      "Longitude": 1.1,
      "Latitude": 2.1
    },
    "InvoiceNumber": "sample string 5",
    "DeviceRegistrationIdentifier": "c377bf15-e433-4ebd-8a1f-a88f0f63a1c3"
  },
  "OriginalTransactionData": {
    "HostTransactionID": 1
  },
  "AmountsRequest": {
    "SubTotalAmount": 1.0,
    "TaxAmount": 2.0,
    "TipAmount": 3.0,
    "SurchargeAmount": 4.0
  },
  "AdditionalData": {
    "AddCardOnFile": true
  }
}

Response Information

Resource Description

Creates post authorization for a credit transaction.

CreditPostAuthorizationResponse
NameDescriptionTypeAdditional information
TransactionRequestData

Transaction request data, such as echo back properties.

PaymentTransactionRequestData

Required

AmountsResp

Response to amount requested.

AmountsResponse

Required

TransactionResultData

Transaction result data.

PaymentTransactionResultData

Required

Result

Transaction result, such as success or failure.

PaymentTransactionResult

Required

AdditionalData

Contains Additional data responses.

AdditionalResponseData

None.

Response Formats

application/json, text/json

Sample:
{
  "TransactionRequestData": {
    "UniqueIdentifier": "sample string 1"
  },
  "AmountsResp": {
    "RequestedTotalAmount": 1.0,
    "ApprovedAmount": 2.0
  },
  "TransactionResultData": {
    "AuthCode": "sample string 1",
    "HostTransactionID": 1,
    "ParentHostTransactionID": 1,
    "RRN": "sample string 2",
    "ReceiptID": 1
  },
  "Result": {
    "ProcessorResponseCode": "sample string 1",
    "ProcessorResponseText": "sample string 2",
    "ResponseCode": 3,
    "ResponseText": "sample string 4"
  },
  "AdditionalData": {
    "CardOnFileToken": "sample string 1"
  }
}