Look Up an Authorization Transaction

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

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'

Before 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.

The response contains the following parameters:

Value Type Description Example
amount integer Amount in minor units requested for this authorization 10098
authCode string This is the Authorization code returned by the issuing bank 026189
availableToSettle integer Amount available to settle in minor units. If this value is 0 then the authorization has been fully settled (captured) 10098
avsResponse enum

Address Verification Service 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.

MATCH
card/lastDigits string Returns the last four digits of the card used in the request 1111
card/type enum

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
VI
currencyCode string

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

USD
id string Unique id for this authorization. e50e19a6-8edd-44ec-abc4-18d0a97d51d8
links array of link objects

Contains a single "self" link which can be used to fetch details about this authorization

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. OnlineStore
merchantDescriptor/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.

12345678
status enum

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.
COMPLETED
txnTime string Transaction time and date in UTC format 2013-12-14T15:12:18Z

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:

Did you find this page useful?