---
title: "Get payment"
method: GET
path: "/payments/{transId}"
tags: ["Payments"]
---

# Get payment

`GET /payments/{transId}`

Get a previous payment (transaction).

## Path parameters

- `transId` number, required

## Response `200`

A transaction object.

- Transaction
  - `id` number
  - `authorizing_merchant_id` integer — The id of the merchant that authorized the transaction.
  - `approved` integer
  - `message_id` number
  - `message` string
  - `auth_code` string
  - `created` string, date-time — Time stamp of when the transaction occurred
  - `device_channel` '02' | '03' — Type of channel used to initiate the transaction. 02 = Browser, 03 = 3DS Requestor.
  - `amount` number, double — A decimal value in dollars. Uses up to two decimal places.
  - `order_number` string
  - `type` string
  - `comments` string
  - `batch_number` string
  - `total_refunds` number, double
  - `total_completions` number, double
  - `payment_method` string
  - `card` CardGetTransactionResponse
    - `card_type` 'AM' | 'DI' | 'JB' | 'MC' | 'NN' | 'VI' | 'PV' | 'MD' — The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard
    - `last_four` string — The last 4 digits of the credit card used in the transaction
    - `cvd_result` integer — Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided
    - `address_match` integer — Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match.
    - `avs_result` string — Result of street address and Postal/Zip match/mismatch. 0 in case of mismatch. 1 in case of match.
    - `expiry_month` string — a 2 digit representation of the expiry month. For example March is 03.
    - `expiry_year` string — a 2 digit representation of the expiry year. For example 2016 is 16.
    - `cavv_result` string — Result code returned back from performing the 3D Secure Code validation.
    - `processor_token` ProcessorTokenResponse — Token information generated from card request, or what was used to submit payment.
      - `payment_token` string — The payment token.
      - `reporting_token` string — Token used for reporting.
      - `status` 'success' | 'fail' — Status of the token.
      - `source` string — This will contain the name of the processor that is hosting the tokenization feature.
      - `source_data` SourceData — This will contain processor specific data related to the tokenization feature returned for informational use only.
        - `td_token_status` string — This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize
  - `payment_profile` ProfilePurchaseResponse
    - `complete` boolean — False for Pre-Authorize, and true for a payment complete.
    - `customer_code` string — The payment profile ID.
    - `card_id` integer — card_id is always 0 and is deprecated so should be ignored.
  - `billing` BillingAddress
    - `name` string — Name of the person/business
    - `address_line1` string — Street address
    - `address_line2` string — Additional address information(eg; suite number, apartment number, etc)
    - `city` string — The city
    - `province` string — characters (2)
    - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Valid ISO 3166-1 country code
    - `postal_code` string — Postal/Zip code
    - `phone_number` string — Phone number
    - `phone_country_code` string — The country code of the phone number provided.
    - `phone_type` 'm' | 'h' | 'w' — The phone type of the phone number provided - m (Mobile), h (Home) or w (Work).
    - `email_address` string — Email Address
  - `shipping` Address
    - `name` string — Name of the person/business
    - `address_line1` string — Street address
    - `address_line2` string — Additional address information(eg; suite number, apartment number, etc)
    - `city` string — The city
    - `province` string — characters (2)
    - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Valid ISO 3166-1 country code
    - `postal_code` string — Postal/Zip code
    - `phone_number` string — Phone number
    - `phone_country_code` string — The country code of the phone number provided.
    - `email_address` string — Email Address
  - `3d_secure` 3DSecureGETResponse — 3D Secure result data
    - `version` string — 3DS Version
    - `flow_type` string — 3DS flow type
    - `status` string — 3DS status
    - `reason_merchant` string — For merchant use only. Provides a category which identifies the reason for the rejection. [See list of reasons](https://docs.na.worldline-solutions.com/build-your-integration/security-and-fraud-APIs/3ds-20/)
    - `reason_cardholder` string — The reason for the rejection and instructions on what to do. This can be returned to the cardholder.
    - `downgraded` boolean — Indicates whether or not the 3DS transaction was downgraded. A downgraded transaction does not provide a liability shift to the merchant, even if the 3DS authentication result was "Success" or "Attempted".
    - `method_url` string — The outcome of a 3DS Method URL operation performed during the course of a transaction. Either Succeeded (3DS Method URL was initiated and was successful), Failed (3DS Method URL was initiated but failed. The transaction will proceed but without the support of Method URL.) or NotAttempted (3DS Method URL was not requested for this transaction or a validation error existed in the supplied threeDSservertransaction_id).
  - `custom` Custom
    - `ref1` string — custom reference field 1
    - `ref2` string — custom reference field 2
    - `ref3` string — custom reference field 3
    - `ref4` string — custom reference field 4
    - `ref5` string — custom reference field 5
  - `adjusted_by` Adjustment[]
    - `id` number
    - `type` string
    - `approval` number
    - `message` string
    - `amount` number, double — A decimal value in dollars. Uses up to two decimal places.
    - `created` string — The date it was created '2015-04-22T10:03:19.323-07:00'
    - `url` string
  - `links` Link[]
    - `ref` string — Eg. "void" or "return"
    - `href` string — Url to perform the void, return, completion etc.
    - `method` string — Http method. post, put, get etc.

## Other responses

- `400` — Bad Request
- `401` — Authentication Failure
- `402` — Business Rule Violation or Decline
- `403` — Authorization Failure
- `405` — Invalid Request Method
- `500` — Internal Server Error

---

[API](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis.md) · [All operations](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worldline-solutions/worldline-payment-apis/revisions/d661d9e357a1/schema)