Settle a payment

If the Asynchronous Payment Statuses feature is not enabled, this API operation sets the Gateway State field of the payment to Settled and returns the Payment 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 Processed and the Gateway State field to Settled.

Request
path Parameters
payment-key
required
string

The payment number starting with "P-" or the unique payment ID.

header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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

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.

Request Body schema: application/json
required
gatewayReconciliationReason
string

The reason of gateway reconciliation.

gatewayReconciliationStatus
string

The status of gateway reconciliation.

payoutId
string

The payout ID from the gateway side.

settledOn
string <date-time>

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

Responses
200
post/v1/gateway-settlement/payments/{payment-key}/settle
Request samples
application/json
{
  • "gatewayReconciliationReason": "paid",
  • "gatewayReconciliationStatus": "succeeded",
  • "payoutId": "PAYOUT123",
  • "settledOn": "2019-05-07 20:56:32.981"
}
Response samples
application/json
{
  • "accountId": "2c90c8e26a6a5271016a6fda7f922c10",
  • "amount": 332,
  • "appliedAmount": 0,
  • "authTransactionId": null,
  • "bankIdentificationNumber": "411111",
  • "cancelledOn": null,
  • "comment": "",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2019-05-06 11:47:17",
  • "creditBalanceAmount": 0,
  • "currency": "USD",
  • "effectiveDate": "2019-05-06",
  • "financeInformation": null,
  • "gatewayId": "2c90c8e26a6a5271016a74321ba82ce0",
  • "gatewayOrderId": null,
  • "gatewayReconciliationReason": "paid",
  • "gatewayReconciliationStatus": "succeeded",
  • "gatewayResponse": "Approved",
  • "gatewayResponseCode": "100",
  • "gatewayState": "Settled",
  • "id": "2c90c8e26a6a5271016a8e78ba502e4b",
  • "markedForSubmissionOn": null,
  • "number": "P-00000017",
  • "paymentMethodId": "2c90c8e26a6a5271016a6fdf9b5f2caa",
  • "paymentMethodSnapshotId": "2c90c8e26a6a5271016a8e78ba4a2e4a",
  • "payoutId": "PAYOUT123",
  • "referenceId": "5571684390686343603009",
  • "refundAmount": 0,
  • "secondPaymentReferenceId": "549536",
  • "settledOn": "2019-04-06 23:00:00",
  • "softDescriptor": null,
  • "softDescriptorPhone": null,
  • "status": "Processed",
  • "submittedOn": "2019-05-06 11:47:19",
  • "success": true,
  • "type": "Electronic",
  • "unappliedAmount": 0,
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2019-05-06 12:11:05"
}