POST /v1/gateway-settlement/payments/{payment-key}/reject

If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to FailedToSettle, creates a refund for the payment amount, and returns the Refund object as response.

If the Asynchronous Payment Statuses feature is enabled, for ACH and Bank Transfer payments, this API operation sets the Payment Status field to Error and the Gateway State field to FailedToSettle, and unapply the payment if it is already applied.

If the reason code "Payment Rejection" is active in the Reason Codes list, the reason code of the external refund is set to "Payment Rejection". Otherwise, the default reason code in the list is used.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`payment-key`	String	Yes	The payment number starting with "P-" or the unique payment ID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Id`	String	No	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 (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	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.
`Zuora-Entity-Ids`	String	No	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 do not need to set this header.
`Zuora-Org-Ids`	String	No	Comma separated IDs. If you have Zuora Multi-Org 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. If the header is not set, the operation is performed in scope of the user's accessible orgs.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`referenceId`	String	No	Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.
`secondReferenceId`	String	No	The second reference Id. Some gateway uses two unique transaction IDs.
`settledOn`	String	No	The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.
`gatewayResponse`	String	No	The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.
`gatewayReconciliationReason`	String	No	The reason of gateway reconciliation.
`gatewayResponseCode`	String	No	Response message Code returned by the gateway about the transaction status.
`gatewayReconciliationStatus`	String	No	The status of gateway reconciliation.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.