Settlement

Retrieve authorization

Changed on

Use this method to retrieve information about an authorization.

Note: To retrieve an authorization, you need its authorizationId. If you don't have the authorizationId, use our List Authorizations method to search for the authorization.

Our gateway returns the following information about the authorization:

  • Authorization response from the issuing bank.
  • Amount that the issuing bank authorized.
  • Merchant that ran the authorization.
  • Details about the customer's card, the transaction, and the batch.
get/authorizations/{authorizationId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/authorizations/{authorizationId}
  • Auth
    HTTP bearer

Path parameters

authorizationIdinteger required

Unique identifier of the authorization.

Response

Successful request. Returns the requested authorization.

authorizationIdinteger

Unique identifier that we assigned to the authorization.

createdDatestring date

Date that we received the authorization. The format of this value is YYYY-MM-DD.

lastModifiedDatestring date

Date that the authorization was last changed. The format of this value is YYYY-MM-DD.

authorizationResponse'activityCountLimitExceeded' | 'alreadyReversed' | 'approved' | 'approveVip' | 'approveWithId' | 'cannotVerifyPin' | 'cardAuthenticationFailed' | 'cardTypeVerificationError' | 'cashRequestExceedsIssuerLimit' | 'cashServiceNotAvailable' | 'cidVerificationError' | 'contactCardIssuer' | 'cryptographicFailure' | 'dailyThresholdExceeded' | 'declineCvv2Failure' | 'deny' | 'denyAccountCanceled' | 'denyClosedMerchant' | 'denyNewCardIssued' | 'denyPickUpCard' | 'destinationCannotBeFoundForRouting' | 'doNotHonor' | 'duplicateTransmissionDetected' | 'error' | 'exceedsWithdrawalAmountLimit' | 'expiredCard' | 'fileTemporarilyUnavailable' | 'forceStip' | 'formatError' | 'forwardToIssuer' | 'functionNotSupported' | 'honorWithId' | 'incorrectCvv' | 'incorrectPin' | 'ineligibleForResubmission' | 'insufficientFunds' | 'invalidAccount' | 'invalidAccountNumber' | 'invalidAmount' | 'invalidAuthorizationLifeCycle' | 'invalidBillerInformation' | 'invalidCardSecurityCode' | 'invalidCurrencyCode' | 'invalidMerchant' | 'invalidResponse' | 'invalidTransaction' | 'issuerNotAvailable' | 'issuerTimeout' | 'issuerUnavailable' | 'noActionTaken' | 'noCardRecord' | 'noCheckingAccount' | 'noCreditAccount' | 'noFinancialImpact' | 'noReasonToDecline' | 'noSavingsAccount' | 'noSuchIssuer' | 'partialApproval' | 'partialAuthorization' | 'pickUpCard' | 'pickUpCardSpecialCondition' | 'pinChangeRequestDeclined' | 'pinCryptographicErrorFound' | 'pinEntryTriesExceeded' | 'pinNotChanged' | 'pleaseCallIssuer' | 'reenterTransaction' | 'referToCardIssuer' | 'referToCardIssuerSpecialCondition' | 'restrictedCard' | 'reversal' | 'reversalDataInconsistent' | 'revokeAllAuthorizationsOrder' | 'scheduledTransactionstoppedByCardholder' | 'securityViolation' | 'successful' | 'surchargeAmountNotPermitted' | 'suspectFraud' | 'systemMalfunction' | 'transactionAmountExceedsApprovalAmount' | 'transactionCannotBeCompleted' | 'transactionNotAllowedAtMerchant' | 'transactionNotAllowedAtTerminal' | 'transactionNotPermitted' | 'transactionNotPermittedToCardholder' | 'unableToGoOnline' | 'unableToLocateRecordInFile' | 'unableToVerifyPin' | 'unacceptablePin' | 'unknown' | 'unsafePin'

Response from the issuing bank for the authorization.

preauthorizationRequestAmountinteger

Amount that the merchant requested for the authorization. We return the value in the currency's lowest denomination, for example, cents.

currencystring

Currency of the authorization. The value for the currency follows the ISO 4217 standard.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieveAuthorization removed and replaced with settlement_retrieveAuthorization