Wires

Simulate an inbound payment

5min

In this tutorial, you'll learn how to:

✅ Simulate an inbound wire transfer

If you are new to wire transfers we recommend you read the Wires overview before starting this tutorial.

If you are new to APIs and how they work we recommend you read the API overview page before starting this tutorial.

The tutorial uses this API endpoint

API

Description

POST /Wires/v1/payments/simulations

Simulate a post of an inbound wire transfer to an account

Before you begin

Make sure you have

Webhook

Description

Wire.Payment.Received

Inbound wire has been received from another bank

Request a refund by wire transfer

When you call POST /Wires/v1/payments/simulations, the CR sandbox creates a simulation of an inbound wire transfer to a deposit or subledger account so you can see what the inbound transfer looks like and test any automations you are designing. In this example, Stream247 is refunding $19.99 to their customer, Jana Parker, by sending a wire transfer from their JP Morgan Chase account.

POST /Wires/v1/payments/simulations request


These details show in the API response:

The Stream247 account at JP Morgan Chase as the originator sent an inbound wire transfer direction: Inbound, to Jana Parker, the beneficiary, via Cross River Bank2 in the amount of $19.99 reflected in amount as 1999. The payment ID is e68e32c3-a475-4d0b-a6d8-ae3c01186ff4, as seen in the id attribute.

POST /v1/payments/simulations response


The Wire.Payment.Received webhook event fires. The payment ID (e68e32c3-a475-4d0b-a6d8-ae3c01186ff4) appears in the resources object. That is the same ID that you received in the response to your simulation request.

Wire.Payment.Received webhook




🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.