Retrieve authorization | Payroc

using Payroc;
using System.Threading.Tasks;
using Payroc.Reporting.Settlement;
namespace Usage;
public class Example
{
    public async Task Do() {
        var client = new PayrocClient();
        await client.Reporting.Settlement.RetrieveAuthorizationAsync(
            new RetrieveAuthorizationSettlementRequest {
                AuthorizationId = 12345
            }
        );
    }
}

{
  "authorizationId": 65,
  "createdDate": "2024-07-02",
  "lastModifiedDate": "2024-07-02",
  "authorizationResponse": "successful",
  "preauthorizationRequestAmount": 10000,
  "currency": "USD",
  "batch": {
    "batchId": 12,
    "date": "2024-07-02",
    "cycle": "am",
    "link": {
      "rel": "batch",
      "method": "get",
      "href": "https://api.payroc.com/v1/batches/12"
    }
  },
  "card": {
    "cardNumber": "453985******7062",
    "type": "visa",
    "cvvPresenceIndicator": true,
    "avsRequest": true,
    "avsResponse": "Y"
  },
  "merchant": {
    "merchantId": "4525644354",
    "doingBusinessAs": "Pizza Doe",
    "processingAccountId": 38765,
    "link": {
      "rel": "processingAccount",
      "method": "get",
      "href": "https://api.payroc.com/v1/processing-accounts/38765"
    }
  },
  "transaction": {
    "transactionId": 442233,
    "type": "capture",
    "date": "2024-07-02",
    "entryMethod": "swiped",
    "amount": 100,
    "link": {
      "rel": "transaction",
      "method": "get",
      "href": "https://api.payroc.com/v1/transactions/12345"
    }
  }
}

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.

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](https://docs.payroc.com/api/schema/reporting/settlement/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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

authorizationIdintegerRequired

Unique identifier of the authorization.

Response

Successful request. Returns the requested authorization.

authorizationIdinteger

Unique identifier that we assigned to the authorization.

createdDatedate

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

lastModifiedDatedate

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

authorizationResponseenum

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.

batchobject or null

Object that contains information about the batch. If we can't match a dispute to a batch, we don't return 'batch' object.

cardobject

Object that contains information about the card.

merchantobject

Object that contains information about the merchant.

transactionobject

Object that contains summary information about the transaction that the dispute is linked to.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error