plaid

Simulate a refund event in Sandbox

Changed on

Use the /sandbox/transfer/refund/simulate endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as /transfer/event/sync or /transfer/event/list, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

post/sandbox/transfer/refund/simulate

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/transfer/refund/simulate
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

refund_idstring required

Plaid's unique identifier for a refund.

test_clock_idstring nullable

Plaid's unique identifier for a test clock. If provided, the event to be simulated is created at the virtual_time on the provided test_clock.

event_typestring required

The asynchronous event to be simulated. May be: refund.posted, refund.settled, refund.failed, or refund.returned.

An error will be returned if the event type is incompatible with the current refund status. Compatible status --> event type transitions include:

refund.pending --> refund.failed

refund.pending --> refund.posted

refund.posted --> refund.returned

refund.posted --> refund.settled

refund.posted events can only be simulated if the refunded transfer has been transitioned to settled. This mimics the ordering of events in Production.

webhookstring url

The webhook URL to which a TRANSFER_EVENTS_UPDATE webhook should be sent.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status