INinfiniaweb
Payins

Refund Payment

Changed on

Create a refund for a payin. Only completed payins are eligible for refunds.

A refund may still fail after being initially marked as SUCCESS; in such cases, you'll receive a callback with status = FAILED.

To simulate a failed refund in the sandbox, create a payin with amount = 101 and wait for it to complete — it does so asynchronously a few seconds after creation (see the Create Payment endpoint for details).

To refund a deposit, use the Create Refund endpoint from Accounts.

post/refund/

Request

  • Base URL
    https://app2test.infiniaweb.com/infinia_api/v1/payments
  • URL
    https://app2test.infiniaweb.com/infinia_api/v1/payments/refund/
  • Auth
    HTTP basic

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Request body

payment_idstring required

Payment ID to refund

idempotency_keystring

A unique key that ensures a request is processed only once. If the same key is sent with multiple requests, the server returns the original response instead of performing the action again.

descriptionstring

Description for the refund. If supported by the rail, this will be forwarded to the end user. Only alphanumeric characters are allowed.

callback_urlstring

Callback URL to receive the refund updates

Response

Successful Response

status'success'

Changes

  • 9d06fde6b2baRevision changes
    • warning

      the request property's maxLength was set to 512

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status