Sign in
Payment Gateway Reconciliation

Reconcile a refund

Reconciles a refund when receiving the gateway reconciliation request or event.

post/v1/refunds/{refund-key}/reconcile

Path parameters

refund-keystring required

The refund number starting with “R-” or the unique refund ID.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

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 for details.
actionDatestring datetime

The date and time of the refund reconciliation action, in yyyy-mm-dd hh:mm:ss format.

gatewayReconciliationReasonstring

The reason of gateway reconciliation.

gatewayReconciliationStatusstring

The status of gateway reconciliation.

payoutIdstring

The payout ID of the refund from the gateway side.

Example request

{
  "action": "settle",
  "gatewayReconciliationStatus": "paid"
}

Response

OK

accountIdstring

The ID of the customer account that the refund is for.

amountnumber double

The total amount of the refund.

cancelledOnstring nullable

The date and time when the transaction was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstring nullable

Comments about the refund.

createdByIdstring

The ID of the Zuora user who created the refund.

createdDatestring

The date and time when the refund is created, in yyyy-mm-dd hh:mm:ss format.

creditMemoIdstring nullable

The ID of the credit memo that is refunded.

gatewayIdstring

The ID of the gateway instance that processes the refund.

gatewayReconciliationReasonstring nullable

The reason of gateway reconciliation.

gatewayReconciliationStatusstring

The status of gateway reconciliation.

gatewayResponsestring

The message returned from the payment gateway for the refund. This message is gateway-dependent.

gatewayResponseCodestring

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.

idstring

The ID of the refund.

markedForSubmissionOnstring 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.

numberstring

The unique identification number of the refund. For example, R-00000001.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

paymentIdstring

The ID of the payment that is refunded.

paymentMethodIdstring nullable

The unique ID of the payment method that the customer used to make the refund.

paymentMethodSnapshotIdstring

The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.

payoutIdstring nullable

The payout ID of the refund from the gateway side.

reasonCodestring

A code identifying the reason for the transaction.

referenceIdstring

The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

refundDatestring date

The date when the refund takes effect, in yyyy-mm-dd format. For example, 2020-03-01.

refundTransactionTimestring

The date and time when the refund was issued, in yyyy-mm-dd hh:mm:ss format.

secondRefundReferenceIdstring nullable

The transaction ID returned by the payment gateway if there is an additional refund.

settledOnstring

The date and time when the transaction is settled, in yyyy-mm-dd hh:mm:ss format.

softDescriptorstring nullable

A payment gateway-specific field that maps Zuora to other gateways.

softDescriptorPhonestring nullable

A payment gateway-specific field that maps Zuora to other gateways.

statusstring

The status of the refund.

submittedOnstring

The date and time when the refund was submitted, in yyyy-mm-dd hh:mm:ss format.

successboolean

Indicates if the request is processed successfully.

type'External' | 'Electronic'

The type of the refund.

updatedByIdstring

The ID of the Zuora user who last updated the refund.

updatedDatestring

The date and time when the refund was last updated, in yyyy-mm-dd hh:mm:ss format.

Example response

{
  "id": "8ad083f092d66ff90192dc309ec31b7e",
  "number": "R-00000025",
  "status": "Processed",
  "type": "Electronic",
  "methodType": "CreditCard",
  "accountId": "8ad09bce83f1da020183f97e245c1c47",
  "amount": 55,
  "refundDate": "2024-10-30",
  "comment": null,
  "paymentMethodId": null,
  "paymentMethodSnapshotId": "8ad083f092d66ff90192dc309e941b7d",
  "paymentId": "8ad097b48f0b078f018f0df4a6cf2ff4",
  "paymentNumber": "P-00001536",
  "creditMemoId": null,
  "reasonCode": "Other",
  "gatewayId": "8ad095dd813e750f0181461a8e350ce7",
  "paymentGatewayNumber": null,
  "gatewayResponse": "This transaction has been approved by the gateway.",
  "gatewayResponseCode": "approve",
  "gatewayState": "Settled",
  "markedForSubmissionOn": null,
  "referenceId": 5066779.708498786,
  "secondRefundReferenceId": null,
  "softDescriptor": null,
  "softDescriptorPhone": null,
  "submittedOn": "2024-10-30 14:50:27",
  "settledOn": "2024-11-13 16:07:24",
  "cancelledOn": null,
  "createdDate": "2024-10-30 14:50:26",
  "createdById": "8ad084a67f9c7138017fab8a8b511b5a",
  "updatedDate": "2024-11-13 16:07:24",
  "updatedById": "8ad084a67f9c7138017fab8a8b511b5a",
  "refundTransactionTime": "2024-10-30 14:50:27",
  "financeInformation": {
    "bankAccountAccountingCode": null,
    "bankAccountAccountingCodeType": null,
    "unappliedPaymentAccountingCode": "Accounts Receivable",
    "unappliedPaymentAccountingCodeType": "AccountsReceivable",
    "transferredToAccounting": "No"
  },
  "gatewayReconciliationStatus": "paid",
  "gatewayReconciliationReason": null,
  "payoutId": null,
  "success": true
}

Changes