Create Return Out Transaction

Create a Return Out transaction to return funds from a previously received Pay-in transaction.

post/return-outs/sweepReturn

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/return-outs/sweepReturn
  • Auth
    API key in header Authorization

Request body

transactionIdstring required

UUID of the original pay-in transaction. (e.g.f1b25bc4-d88d-44bb-afc5-5ab32210063a)

sourceAccountIdstring

ID of the master account from which the return funds will be sourced. If not provided, the system will select the primary master account.

commentstring

Comment providing additional information about the return.

reasonCode'REQUESTED_BY_CUSTOMER' | 'REFUND_REQUEST_BY_CUSTOMER' | 'NOT_SPECIFIED_REASON_CUSTOMER' | 'OTHER' required

Response

Created

object required

Changes

No recorded changes to this operation across all 1 revision of this API.