Sign in
Payment Gateway Reconciliation

Reverse a payment

If the <a href="https://docs.zuora.com?resourceId=payments-electronic-payment-processing" target="_blank">Asynchronous Payment Statuses</a> feature is not enabled, this API operation sets the Gateway State field of the payment to Settled, creates a refund for the amount specified in the request, and returns the Refund object as response.

If the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments that are reversed before they are settled, this API operation sets the Payment Status field to Processed, sets the Gateway State field of the payment to Settled, creates an external refund for the amount specified in the request, and returns the Refund object as response.

If the reason code "Payment Reversal" is active in the <a href="https://docs.zuora.com?resourceId=payments-creating-and-editing-reason-codes" target="_blank">Reason Codes</a> list, the reason code of the external refund is set to "Payment Reversal". Otherwise, the default reason code in the list is used.

post/v1/gateway-settlement/payments/{payment-key}/chargeback

Path parameters

payment-keystring required

The payment number starting with "P-" or the unique payment 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

amountnumber required

The amount that needs to be reversed (chargeback). It cannot be greater than the total Payment amount.

gatewayReconciliationReasonstring

The reason of gateway reconciliation.

gatewayReconciliationStatusstring

The status of gateway reconciliation.

gatewayResponsestring

The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.

gatewayResponseCodestring

Response message Code returned by the gateway about the transaction status.

payoutIdstring

The payout ID from the gateway side.

referenceIdstring

Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.

secondReferenceIdstring

The second reference Id. Some gateways use two unique transaction IDs.

settledOnstring

The date and time of the transaction settlement. The format is yyyy-mm-dd hh:mm:ss.

Example request

{
  "amount": 10
}

Response

OK

accountIdstring

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

amountnumber double

The total amount of the payment.

cancelledOnstring nullable

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

commentstring nullable

Comments about the payment.

createdByIdstring

The ID of the Zuora user who created the refund.

createdDatestring

The date and time when the chargeback is created, in yyyy-mm-dd hh:mm:ss format. For example, 2019-03-01 15:31:10.

creditMemoIdstring nullable

The ID of the credit memo that is refunded.

gatewayIdstring nullable

The ID of the gateway instance that processes the payment.

gatewayReconciliationReasonstring nullable

The reason of gateway reconciliation.

gatewayReconciliationStatusstring nullable

The status of gateway reconciliation.

gatewayResponsestring nullable

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

gatewayResponseCodestring nullable

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

gatewayState'Submitted' | 'NotSubmitted' | 'Settled' | 'FailedToSettle'

The status of the payment in the gateway; specifically used for reconciliation.

idstring

The ID of the payment chargeback.

markedForSubmissionOnstring nullable

The date and time when a charge 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 payment. For example, P-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

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

paymentMethodSnapshotIdstring nullable

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 from the gateway side.

reasonCodestring

A code identifying the reason for the transaction.

referenceIdstring nullable

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, 2017-03-01.

refundTransactionTimestring nullable

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

submittedOnstring nullable

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

successboolean

Returns true if the request was processed successfully.

type'External' | 'Electronic'

The type of the payment.

updatedByIdstring

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

updatedDatestring

The date and time when the payment was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2019-03-02 15:36:10.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.