--- title: "Reconcile a refund" method: POST path: "/v1/refunds/{refund-key}/reconcile" tags: ["Payment Gateway Reconciliation"] --- # Reconcile a refund `POST /v1/refunds/{refund-key}/reconcile` Reconciles a refund when receiving the gateway reconciliation request or event. ## Path parameters - `refund-key` string, required ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Request body - POSTReconcileRefundRequest - `action` 'settle' | 'reject' — The action of the refund reconciliation. - `settle`: Sets Gateway State to "Settled" and returns the refund object as response. - `reject`: Sets Gateway State to "FailedToSettle" and handle the event according to the settings configured in the Gateway Reconciliation Configuration in Payments Settings through Zuora UI. See [Configure how to handle refund rejected events](https://docs.zuora.com?resourceId=payments-enable-batch-gateway-reconciliation) for details. - `actionDate` string, datetime — The date and time of the refund reconciliation action, in `yyyy-mm-dd hh:mm:ss` format. - `gatewayReconciliationReason` string — The reason of gateway reconciliation. - `gatewayReconciliationStatus` string — The status of gateway reconciliation. - `payoutId` string — The payout ID of the refund from the gateway side. ## Response `200` OK - POSTReconcileRefundResponse - `accountId` string — The ID of the customer account that the refund is for. - `amount` number, double — The total amount of the refund. - `cancelledOn` string, nullable — The date and time when the transaction was cancelled, in `yyyy-mm-dd hh:mm:ss` format. - `comment` string, nullable — Comments about the refund. - `createdById` string — The ID of the Zuora user who created the refund. - `createdDate` string — The date and time when the refund is created, in `yyyy-mm-dd hh:mm:ss` format. - `creditMemoId` string, nullable — The ID of the credit memo that is refunded. - `financeInformation` object — Container for the finance information related to the refund. - `bankAccountAccountingCode` string, nullable — The accounting code that maps to a bank account in your accounting system. - `bankAccountAccountingCodeType` string, nullable — The type of the accounting code that maps to a bank account in your accounting system. - `transferredToAccounting` 'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore' — Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. - `unappliedPaymentAccountingCode` string — The accounting code for the unapplied payment. - `unappliedPaymentAccountingCodeType` string — The type of the accounting code for the unapplied payment. - `gatewayId` string — The ID of the gateway instance that processes the refund. - `gatewayReconciliationReason` string, nullable — The reason of gateway reconciliation. - `gatewayReconciliationStatus` string — The status of gateway reconciliation. - `gatewayResponse` string — The message returned from the payment gateway for the refund. This message is gateway-dependent. - `gatewayResponseCode` string — The code returned from the payment gateway for the refund. This code is gateway-dependent. - `gatewayState` 'Settled' | 'FailedToSettle' — The status of the refund in the gateway; specifically used for reconciliation. - `id` string — The ID of the refund. - `markedForSubmissionOn` string, nullable — The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. - `methodType` 'ACH' | 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'WireTransfer' | 'DebitCard' | 'CreditCardReferenceTransaction' | 'BankTransfer' | 'Other' — How an external refund was issued to a customer. - `number` string — The unique identification number of the refund. For example, R-00000001. - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. - `paymentId` string — The ID of the payment that is refunded. - `paymentMethodId` string, nullable — The unique ID of the payment method that the customer used to make the refund. - `paymentMethodSnapshotId` string — The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. - `payoutId` string, nullable — The payout ID of the refund from the gateway side. - `reasonCode` string — A code identifying the reason for the transaction. - `referenceId` string — The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. - `refundDate` string, date — The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2020-03-01. - `refundTransactionTime` string — The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. - `secondRefundReferenceId` string, nullable — The transaction ID returned by the payment gateway if there is an additional refund. - `settledOn` string — The date and time when the transaction is settled, in `yyyy-mm-dd hh:mm:ss` format. - `softDescriptor` string, nullable — A payment gateway-specific field that maps Zuora to other gateways. - `softDescriptorPhone` string, nullable — A payment gateway-specific field that maps Zuora to other gateways. - `status` string — The status of the refund. - `submittedOn` string — The date and time when the refund was submitted, in yyyy-mm-dd hh:mm:ss format. - `success` boolean — Indicates if the request is processed successfully. - `type` 'External' | 'Electronic' — The type of the refund. - `updatedById` string — The ID of the Zuora user who last updated the refund. - `updatedDate` string — The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)