createCapture

MUTATION

This mutation will capture an authorization for a merchant.

Arguments

merchant_uidRequired

String

The Pay Theory unique identifier assigned to the merchant that the authorization belongs to.

authorization_idRequired

String

The Pay Theory unique identifier assigned to the authorization that you are looking to capture.

amountRequired

Int

The amount of the capture in cents. If auth has a feemode of SERVICEFEE this amount would be the amount without the fee included.

fee

Int

The amount of the service fee in cents. Required if you are capturing an auth that has a feemode of SERVICEFEE.

send_receipt

Boolean

Can be set to true to send a receipt to the payor.

receipt_description

String

A custom description that will be displayed on the receipt.

allow_reauth

Boolean

Whether to allow the capture to be reauthorized in the case that it is expired. If this is set to true Pay Theory will reauthorize the capture if it is expired. If this is set to false or left blank, the capture will fail if it is expired.

allow_exceeded_amount

Boolean

Whether to allow the capture to exceed the amount of the authorization. If this is set to true Pay Theory will release the hold on the current auth and create a new auth for the amount of the capture. If this is set to false or left blank, the capture will fail if the amount is greater than the amount of the authorization.

split

[SplitInput]

An array of split objects to distribute the transaction amount to different accounts. The sum of all split amounts must equal the transaction amount.

Response

Transaction

account_code

String| null

Customer defined account code for the transaction.

ach_return_details

AchReturnDetails| null

The details of the ACH return if any.

additional_purchase_data

AdditionalPurchaseData| null

The additional purchase data.

authorization_id

String| null

The authorization id for the transaction.

avs_status

AvsStatus| null

The AVS status for the transaction.

Values

NO_MATCHPOSTAL_CODE_AND_STREET_MATCHPOSTAL_CODE_MATCHSTREET_MATCHUNKNOWN

currency

String| null

The type of currency for the transaction.

device_id

String| null

-

dispute_status

DisputeStatus| null

The status of the dispute if any.

Values

INQUIRYLOSTPENDINGWON

failure_reasons

[String]| null

List of strings, if any, detailing the reason a transaction failed. See Failure Codes for a complete list of failure codes and descriptions.

fee_mode

FeeMode| null

The fee mode on the transaction.

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

fees

Int| null

The amount of the fees charged for the transaction.

flag_for_review

TransactionReviewStatus| null

A status indiciator for any transactions that are in review. When a transaction is in review the funds will not settle to the merchant until resolved.

Values

EXCEEDS_AUTHEXCEEDS_FEE_LIMITEXCEEDS_THRESHOLDPOTENTIAL_DUPLICATE

gross_amount

Int| null

The total amount of the transaction.

invoice

Invoice| null

The invoice object for the transaction if any.

is_settled

Boolean| null

Whether the transaction has been settled.

merchant

ListMerchant| null

The merchant object of the merchant the transaction belongs to.

merchant_uid

String| null

The Pay Theory unique identifier for the merchant the transaction is for.

metadata

AWSJSON| null

Custom defined JSON object to be stored with the transaction.

net_amount

Int| null

The total amount of the transaction after fees.

parent_id

String| null

The Pay Theory unique identifier for the parent transaction if any.

payment_method

PaymentMethodToken| null

The payment method used to make the transaction.

processor

String| null

-

recurring

RecurringPayment| null

The recurring payment that the transaction belongs to if any.

reference

String| null

Customer defined reference for the transaction.

refund_reason

RefundReason| null

The reason for the refund if any.

refund_voidable

Boolean| null

Whether the refund can be voided.

refunded_amount

Int| null

The amount of the transaction that has been refunded if any.

sale_id

String| null

The sale id for the transaction if any.

settlement_batch

Int| null

The unique settlement batch number the transaction belongs to if settled.

splits

[Split]| null

An array of split objects associated with this transaction, if any.

status

TransactionStatus| null

The status of the transaction.

Values

CANCELEDFAILEDPARTIALLY_REFUNDEDPENDINGREFUNDEDRETURNEDSETTLEDSUCCEEDEDVOIDED

timezone

String| null

The timezone the transaction was made in.

transaction_date

AWSDateTime| null

The date the transaction was made.

transaction_id

String| null

The Pay Theory unique identifier for the transaction.

transaction_type

TransactionType| null

The type of transfer that was made.

Values

ACH_RETURNDEBITFAILUREREVERSAL

updated_row_at

AWSDateTime| null

The date and time the transaction was last updated.

Examples

Capture an authorization

Captures the amount held by an authorization. You can capture an authorization once, so a partial capture releases the rest.

SUCCESS 200

GRAPHQL

mutation CreateCapture(
  $merchant_uid: String!
  $authorization_id: String!
  $amount: Int!
) {
  createCapture(
    merchant_uid: $merchant_uid
    authorization_id: $authorization_id
    amount: $amount
  ) {
    transaction_id
    merchant_uid
    gross_amount
    net_amount
    status
    fee_mode
    authorization_id
  }
}