Look Up an Authorization Transaction

GET /cardpayments/v1/accounts/account_id/auths/transaction_id

See our API Reference section for a list of all the JSON attributes and types available for the authorization object returned in the response. Note that some parameters are used only when requesting an authorization. See the following links for full details about looking up authorizations and all possible request and response parameters:

You can look up an existing authorization transaction by providing your account number and the transaction ID (returned in the authorization response) in the URL as follows:

Request Example
curl -X GET https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/ebf6ae3d-88e1-40da-9b98-81044467345b \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json'

Prior to trying the example, you should:

  • Replace the account number (89987201) in the URL with the test account number you received.
  • Replace the API key (after the -u) with the API key you received.
  • Replace the transaction ID in the URL with a transaction ID returned in an earlier response to an authorization request you submitted.

If you do not have a transaction ID, you can look up a transaction based on the merchantRefNum you supplied with the original authorization request:

GET /cardpayments/v1/accounts/account_id/auths?merchantRefNum=merchantRefNum

Request Example
curl -X GET https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths?merchantRefNum=demo-1 \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json'

Prior to trying the example, you should:

  • Replace the account number (89987201) in the URL with the test account number you received.
  • Replace the API key (after the -u) with the API key you received.
Response Example
{
  "links":[
    {
      "rel":"self",
      "href":"https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/ebf6ae3d-88e1-40da-9b98-81044467345b"
    }
  ],
  "id":"ebf6ae3d-88e1-40da-9b98-81044467345b",
  "merchantRefNum":"demo-1",
  "txnTime":"2014-05-05T12:28:20Z",
  "status":"COMPLETED",
  "amount":10098,
  "availableToSettle":10098,
  "card":{
    "type":"VI",
    "lastDigits":"1111",
    "cardExpiry":{
      "month":2,
      "year":2027
    }
  },
  "authCode":"118428",
  "billingDetails":{
    "street":"100 Queen Street West",
    "city":"Toronto",
    "state":"ON",
    "country":"CA",
    "zip":"M5H2N2"
  },
  "merchantDescriptor":{
    "dynamicDescriptor":"Test",
    "phone":"123-1234123"
  },
  "currencyCode":"CAD",
  "avsResponse":"MATCH"
}

The response contains the following parameters:

Element Child Element Type Description
links array of link objects

This parameter contains a single self link which can be used to fetch details about this authorization.

id string
length<=36
This is the unique ID for this authorization.
merchantRefNum string
length<=255
This is the merchant reference number.
txnTime string This is the transaction time and date in UTC format.
status enum

This is the status of the authorization. Possible values are:

  • RECEIVED – Our system has received the request and is waiting for the downstream processor’s response.
  • COMPLETED – The transaction has been completed.
  • HELD – The transaction has been placed on hold due to risk considerations.
  • FAILED – The transaction failed, due to either an error or being declined.
  • CANCELLED – The request has been fully reversed.
amount integer
max=99999999999
This is the amount in minor units requested for this authorization.
availableToSettle integer
max=99999999999
This is the amount available to settle in minor units. If this value is 0 then the authorization has been fully settled (captured).
card lastDigits string
length=4
This is the last four digits of the card used for the request.
type enum

This is the type of card used in the request. Possible values are:

  • AM – American Express
  • DC – Discover
  • JC – JCB
  • MC – Mastercard
  • MD – Maestro
  • SO – Solo
  • VI – Visa
  • VD – Visa Debit
  • VE – Visa Electron
authCode string
length<=50
This is the authorization code returned by the issuing bank.
billingDetails street string
length<=50
This is the first line of the street address in the billing address.
city string
length<=40
This is the city in the billing address.
state string
length<=40
This is the state/province in the billing address.
country string
length=2
This is the country in the billing address.
zip string
length<=10
This is the zip/postal code in the billing address.
merchantDescriptor dynamicDescriptor

string
length<=20

This is a merchant descriptor that will be displayed on a customer’s card statement. You can either send this information in the request or ask Paysafe to configure a default value for this parameter for your account.
phone

string
length<=13

This is the merchant’s phone number, which will be appended to the merchant descriptor on a customer’s card statement.
You can either send this information in the request or ask Paysafe to configure a default value for this parameter for your account.

currencyCode string

This is the three-digit currency code of the merchant account specified in the account_id request URL parameter when this authorization was created.

avsResponse enum

This is the Address Verification Service (AVS) response from the card issuer:

  • MATCH
  • MATCH_ADDRESS_ONLY
  • MATCH_ZIP_ONLY
  • NO_MATCH
  • NOT_PROCESSED
  • UNKNOWN

The address in the billingDetails object in the initial authorization request is verified against the address the card issuer has on file for the card.

Did you find this page useful?