Skip to content
/
Retrieve payment details...

Retrieve payment details by Transaction ID

Request

This endpoint is used to retrieve payment details with the Transaction ID (transId).

Security
bearer and basic and apiKey
Path
idstringrequired

ID of transaction

curl -i -X GET \
  -u '<username>:<password>' \
  'https://test.computop-paygate.com/api/v2/payments/getByTransId/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
externalIntegrationIdstring

External integration identifier

cardholderConsentToStoreboolean
amountobject(amountPaymentDetails)
languagestring

Language code to determine the language of the payment form and customer communication where applicable.

captureMethodobject(captureMethod)
credentialOnFileobject(credentialOnFile)
orderobject(order)
urlsobject(baseUrls)
billingAddressobject(shippingAddress)
shippingobject(shipping)
statementDescriptorstring

Short, clear description of the transaction that appears on the customer's statement. It is recommend sending a maximum of 22 characters. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters / - ? : ( ) . , +

customerInfoobject(paymentDetailsCustomerInfo)
expirationTimeany, (date-time)

Transaction expiry timestamp (UTC).

fraudDataobject(fraudData)
paymentFacilitatorobject(paymentFacilitator)

Object specifying SubMerchant (Payment Facilitator) details.

browserInfoobject(browserInfo)
deviceobject(device)
channelstring

Specifies the sales or interaction channel through which the transaction is initiated.

paymentPlanIdstring

Payment plan unique id.

payIdstring

A unique identifier assigned by Computop Paygate to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.

merchantIdstring
transIdstring

Transaction ID created in your system. It should be unique for each payment.

xIdstring

A unique identifier assigned by Computop Paygate for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same.

refNrstring

Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually.

statusstring

Status of the transaction.

responseCodestring

Response code of the transaction.

responseDescriptionstring

Response description associated with the response code.

metadataobject

A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Paygate will return the data as it is in the response.

paymentMethodsobject(paymentByIdResponse)
Response
{
  "payId": "ed7773c09f314c45b2a0de47a1994e1d",
  "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca",
  "transId": "20240103-121913-554",
  "merchantId": "MerchantIdTest",
  "status": "OK",
  "responseCode": "00000000",
  "responseDescription": "success",
  "refNr": "refNr01",
  "metadata": {
    "userData": "my user data",
    "plain": "some plain text",
    "key1": "value1",
    "key2": "value2"
  },
  "paymentMethods": {
    "type": "ALIPAY",
    "alipay": { … }
  }
}