Transactions

Get Auth Settle Detail

Changed on

Use the Get Auth Settle Detail endpoint to retrieve a single coalesced detail record spanning both the authorization and settlement data. You can input either an auth_id or a settle_id if the authorization has settled or completed.

This endpoint currently supports only transactions on these networks: Allpoint, Cirrus, Mastercard (credit), Maestro (debit), Visa, Visa Interlink, Visa Plus.

Read <a href="doc:transaction-ids" target="_blank">Transaction IDs</a> for an explanation of how the IDs are generated.

post/getAuthSettleDetail

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/getAuthSettleDetail
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

idstring required

The transaction ID. Use idType to specify whether this is an auth_id or a settle_id. Pattern: String Example: "482913"

idType'auth_id' | 'settle_id' required

The kind of identifier supplied in id. Pattern: One of "auth_id", "settle_id" Example: "auth_id"

networkCode'M' | 'V' | 'I' | 'Z' | 'A' | 'C' | 'P' required

The network table that contains the id. See <a href="doc:transaction-ids#authorization-identifiers" target="_blank">Authorization identifiers</a> for an explanation of network tables, and refer to the Program API column on the <a href="ref:api-reference-card-authorization-network-codes" target="_blank">Network Codes</a> page for the definitions. Pattern: Single character Example: "M"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

Example request

{
  "accountNo": "074103447228",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "id": "482913",
  "idType": "auth_id",
  "networkCode": "M",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

system_timestampstring date-time nullable required

A system generated timestamp

Changes