Simulate an inbound wire

simulations allow testing certain inbound payment flows in our sandbox environment simulating an inbound wire transfer is triggered explicitly using the api endpoint outlined below as well as the webhook employed if you are new to wires we recommend you read the wires before starting this tutorial the tutorial assumes you have a knowledge of apis and how they work for more information on sending api calls, see the structure 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 get api credentials partner id accounts, cards and payment events the following webhook 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 cross river 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 { "accountnumber" "2846838676", "originator" { "idcode" "d", "identifier" "4236598541", "name" "stream247", "address1" "257 dalton groves", "address2" "barton city, mi 48075" }, "businessfunctioncode" "ctr", "senderroutingnumber" "021000021", "senderdiname" "jp morgan chase", "originatorfi" { "idcode" "f", "identifier" "021000021", "name" "jp morgan chase" }, "beneficiaryreference" "refund sep2022", "amount" 1999 } 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 { "id" "e68e32c3 a475 4d0b a6d8 ae3c01186ff4", "accountnumber" "2846838676", "referenceid" "w2204571at5", "direction" "inbound", "paymenttype" "transfer", "source" "api", "status" "hold", "posting" "pending", "amount" 1999, "currency" "usd", "purpose" "simulation", "imad" "1563371856856662630811", "omad" "942955532798176168895701363106962410", "businessfunctioncode" "ctr", "typecode" "1000", "senderroutingnumber" "021000021", "sendername" "jp morgan chase", "senderreference" "test", "receiverroutingnumber" "021214891", "receivername" "cross river bank2", "originatingfi" { "idcode" "f", "identifier" "021000021", "name" "jp morgan chase" }, "originator" { "idcode" "d", "identifier" "4236598541", "name" "stream247", "address1" "257 dalton groves", "address2" "barton city, mi 48705" }, "beneficiaryfi" { "idcode" "f", "identifier" "021000021", "name" "cross river bank", "address1" "400 kelby street", "address2" "fort lee, nj", "address3" "us" }, "beneficiary" { "idcode" "d", "identifier" "2846838676", "name" "john smith", "address1" "250 kuhn highway", "address2" "", "address3" "grover, nc 28073" }, "beneficiaryreference" "refund sep2022", "receiptdate" "0214", "receipttime" "1201", "wasreversed" false, "isinternational" false, "createdat" "2022 02 14t12 01 02 460748 05 00", "effectivedate" "2022 02 14t00 00 00 05 00", "originalpaymentid" "e68e32c3 a475 4d0b a6d8 ae3c01186ff4", "partnerid" "f03ff044 8883 4939 9d22 ade301661897", "productid" "9b8490c9 ccac 4f7d 8b49 ae3800e6b418", "lastmodifiedat" "2022 02 14t12 01 02 4967164 05 00", "postingcode" "ok" } 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 { "id" "3809b97e 58dc 4082 bc64 ae3c01188e1c", "eventname" "wire payment received", "status" "pending", "partnerid" "f03ff044 8883 4939 9d22 ade301661897", "createdat" "2022 02 14t12 01 28 197 05 00", "resources" \[ "wires/v1/payments/e68e32c3 a475 4d0b a6d8 ae3c01186ff4" ], "details" \[] }