Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Payments

Refund payment

Refunds a specified payment on a specified account. A reason must be provided. Optionally, specify an amount for a partial refund. This operation supports Portfolio Access Tokens.

  • Payment types: Only CreditCardPayment and AlternativePayment can be refunded. Other payment types will fail.
  • Refund information: The refund is a payment itself. To get more information, use Get all payments with the RefundId as the PaymentId.
  • Potential failures: This operation initiates the refund process, but refunds can fail if the payment is in a Pending state and fails processing. To check the status of a pending payment, including refunds, use Get all payments.
post/api/connector/v1/payments/refund

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdstring uuid nullable

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

PaymentIdstring uuid required

Unique identifier of specific Payment.

AccountIdstring uuid required

Unique identifier of the account (for example Customer) the payment belongs to.

Reasonstring required

Refund reason.

ValueToRefundnumber double nullable

Refund amount. If not provided, the whole payment will be refunded.

Response

OK

PaymentIdstring uuid required

Unique identifier of specific Payment.

RefundIdstring uuid required

Unique identifier of refund.

Type'CreditCardPayment' | 'AlternativePayment' required

CreditCardPayment

AlternativePayment

State'Charged' | 'Canceled' | 'Pending' | 'Failed' | 'Verifying' required

Charged

Canceled

Pending

Failed

Verifying