idempotencyLookup

QUERY

Looks up a payment creation key for the supplied merchant and operation. An unused key returns null. A completed record returns its status, linked transaction or authorization ID, and lock and expiry timestamps. The same key can be used independently for createTransaction and createAuthorization.

Arguments

merchant_uidRequired

String

The Pay Theory unique identifier for the merchant that owns the idempotency key.

operationRequired

IdempotencyOperation

The payment creation operation to look up.

Values

CREATE_AUTHORIZATIONCREATE_TRANSACTION

idempotency_keyRequired

String

The caller-provided idempotency key.

Response

IdempotencyLookup

merchant_uid

String

The Pay Theory unique identifier for the merchant that owns the idempotency key.

operation

IdempotencyOperation

The payment creation operation the key was scoped to.

Values

CREATE_AUTHORIZATIONCREATE_TRANSACTION

idempotency_status

IdempotencyStatus

The status of the retained idempotency record.

Values

IN_PROGRESSCOMPLETED

transaction_id

String| null

The Pay Theory unique identifier for the matching transaction, when the key was used with createTransaction.

transaction

Transaction| null

The matching transaction, when it has been created.

authorization_id

String| null

The Pay Theory unique identifier for the matching authorization, when the key was used with createAuthorization.

authorization

Authorization| null

The matching authorization, when it has been created.

locked_until

AWSDateTime| null

The time until which the original request may still be considered in progress.

expires_at

AWSDateTime| null

The time after which the idempotency record is no longer retained.

Examples

Look up a completed transaction

Shows the completed record for a transaction key, including its transaction ID and timestamps.

SUCCESS 200

GRAPHQL

query IdempotencyLookup(
  $merchant_uid: String!
  $operation: IdempotencyOperation!
  $idempotency_key: String!
) {
  idempotencyLookup(
    merchant_uid: $merchant_uid
    operation: $operation
    idempotency_key: $idempotency_key
  ) {
    merchant_uid
    operation
    idempotency_status
    transaction_id
    authorization_id
    locked_until
    expires_at
  }
}