POST payments/credit/authorization

Creates authorization for a credit transaction.

Request Information

URI Parameters

None.

Body Parameters

request payload

Name	Description	Type	Additional information
TransactionData	Specific information for the transaction.	CreditAuthorizationTransactionData	Required
AmountsReq	Amount requested for this transaction.	CreditAuthorizationAmountsRequest	Required
PaymentData	Payment data for this transaction.	CreditAuthorizationPaymentData	Required
AdditionalData	Contains Additional data for processing a credit authorization.	CreditAuthorizationAdditionalData	None.

Request Formats

application/json, text/json

Sample:

{
  "TransactionData": {
    "UniqueIdentifier": "sample string 1",
    "TimeStamp": "2024-04-23T13:42:33.03Z",
    "TotalAmount": 3.0,
    "Description": "sample string 4",
    "GeotagInfo": {
      "Longitude": 1.1,
      "Latitude": 2.1
    },
    "InvoiceNumber": "sample string 5",
    "DeviceRegistrationIdentifier": "a96374a5-0811-4374-8856-fcc759b8ac83"
  },
  "AmountsReq": {
    "SubTotalAmount": 1.0,
    "TaxAmount": 2.0,
    "TipAmount": 3.0,
    "SurchargeAmount": 4.0
  },
  "PaymentData": {
    "EntryMethod": "Standard",
    "CardData": {
      "CardVerificationMethod": "Unknown",
      "PinCode": "sample string 1",
      "PinKeySerialNumber": "sample string 2",
      "ManualCardData": {
        "PAN": "sample string 1",
        "ExpirationDate": "sample string 2",
        "CardHolderName": "sample string 3"
      },
      "SensitiveCardData": {
        "Track1": "sample string 1",
        "Track2": "sample string 2"
      },
      "ProtectedCardData": {
        "Reader": "sample string 1",
        "ReaderEncoding": "None",
        "MaskedCardData": {
          "FirstSix": "sample string 1",
          "LastFour": "sample string 2",
          "CardHolderName": "sample string 3"
        },
        "EncryptedData": {
          "CombinedBlock": "sample string 1",
          "Track1": "sample string 2",
          "Track2": "sample string 3"
        },
        "KeyID": "sample string 2",
        "TrackDataKeySerialNumber": "sample string 3"
      },
      "EMVCardData": {
        "Reader": "sample string 1",
        "ReaderSerialNumber": "sample string 2",
        "ReaderKernelHash": "sample string 3",
        "ReaderConfigurationVersion": "sample string 4",
        "ReaderEncoding": "None",
        "TlvEncrypted": "sample string 5",
        "Tlv": "sample string 6",
        "KeySerialNumber": "sample string 7"
      },
      "CardOnFileData": {
        "Token": "sample string 1"
      }
    },
    "EmvCapable": true
  },
  "AdditionalData": {
    "AddCardOnFile": true
  }
}

Response Information

Resource Description

Creates authorization for a credit transaction.

CreditAuthorizationResponse

Name	Description	Type	Additional information
TransactionRequestData	Transaction request data, such as echo back properties.	PaymentTransactionRequestData	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"
  },
  "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"
  }
}