Wires

Originate a drawdown request

6min
an outbound wire drawdown request, also called a reverse wire, asks a someone to send funds back to you as the requester in this tutorial, you'll learn how to ✅ send a drawdown request if you are new to wires we recommend you read the wires docid\ zaxecgz253epmvur5l4eh documentation 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 api overview docid\ p4oymfdtb4xc52tud3 iu for this tutorial you'll need to understand these terms these definitions are specific to this tutorial the terms might be used slightly differently for a drawdown response term description originator the entity requesting the payment beneficiary the entity receiving the payment originating financial institution the financial institution wherethe payment request comes from intermediary financial institution a financial institution that a payment is routed through (required for international wires, otherwise not always needed) beneficiary financial institution the financial institution that receives the payment request drawdown credit account numbersending financial institution the financial institution that sends the payment request 9 digit routing/aba number of the originating financial institution receiveringfinancial institutionroutingnumber the routing number of the financial institution that receives the payment request drawdown request a request for someone to send a payment by wire the tutorial uses these api endpoints api description wires docid 2jf5lvztusac2jqpi9pjf requests an inbound wire transfer the tutorial uses these webhooks webhook description wire payment sent outbound wire has been transmitted to the federal reserve and has been successfully acknowledged imad number is now available wire payment received inbound wire payment received successfully wire payment rejected outbound wire could not be processed due to compliance reasons or was rejected by the federal reserve before you begin make sure you have bank rails docid\ kbym9o05dwmdjsf8k7lzi account number of the account requesting the payment receiver routing number 1 register the relevant webhook events to receive the webhook events for this tutorial both partner accounts need to banking and payments docid\ dgnysfx9f7pnesmuxnwsp each specific webhook event type once you are registered, the event objects are sent to the registered urls the event object contains a list of resource identifiers used to download details on each event 2 request a wire payment when you initiate an outbound wire drawdown request (drc 1031), the request is sent to the specified bank where the account responsible for the payout is held the bank's response includes the payment status and other relevant information about the request webhook events are triggered when specific payment statuses are set in this tutorial, the pmr corporation requests a $500,000 wire payment from lindberg incorporated if you want to enter originator values yourself (instead of the system populating those attributes based on your account number), ensure that allow custom originator is enabled on the product or account call post /v1/payments/corporate drawdown requests for this call, some/all attributes are required a full list of attributes is found wires docid 2jf5lvztusac2jqpi9pjf your tutorial request example api call { "accountnumber" "2714035231", "originator" { "idcode" "d", "identifier" "2714035231", "name" "pmr corp", "address1" "10431 howe drive", "address2" "shawnee mission ks 66206", "address3" "us" }, "receiverroutingnumber" "026009593", "drawdowncreditaccountnumber" "021214891", "beneficiaryfi" { "idcode" "f", "identifier" "021214891", "name" "cross river bank", "address1" "400 kelby street", "address2" "fort lee nj 07024", "address3" "us" }, "drawdowndebitaccount" { "idcode" "d", "identifier" "777555333", "name" "lindberg incorporated", "address1" "5 stop st", "address2" "new york ny 52555", "address3" "us" }, "beneficiary" { "idcode" "d", "identifier" "2714035231", "name" "pmr corp", "address1" "10431 howe drive", "address2" "shawnee mission ks 66206", "address3" "us" }, "beneficiaryreference" "testref", "originatortobeneficiary1" "1string", "originatortobeneficiary2" "2string", "originatortobeneficiary3" "3string", "originatortobeneficiary4" "4string", "debitdrawdownadvicecode" "wre", "debitdrawdowninformation1" "string1", "debitdrawdowninformation2" "string2", "debitdrawdowninformation3" "string3", "debitdrawdowninformation4" "string4", "debitdrawdowninformation5" "string5", "receiverfiinformation1" "astring", "receiverfiinformation2" "bstring", "receiverfiinformation3" "cstring", "receiverfiinformation4" "dstring", "receiverfiinformation5" "estring", "fitofiinformation1" "hstring", "fitofiinformation2" "istring", "fitofiinformation3" "jstring", "fitofiinformation4" "kstring", "fitofiinformation5" "lstring", "fitofiinformation6" "mstring", "amount" 50000000, "purpose" "drawdown testing", "clientidentifier" "40708c24 7dee 49c3 b4d2 c48d876f1f5e" } we recommend that you save the request id , you can see in the response header to use if you need to contact the cross river support team about that specific call see response headers docid\ cq98yyfxbwuqal6eiyvrf for more detail about this unique id a successful api call returns a json response with the details of the drawdown request sample response { "id" "e201c363 1039 45cc 99c3 af8500eebb92", "accountnumber" "2714035231", "referenceid" "w230093gg8s", "direction" "outbound", "paymenttype" "drawdown", "source" "opsportal", "status" "created", "posting" "pending", "partnerauthorization" "notrequired", "partnerauthorization2" "notrequired", "amount" 50000000, "currency" "usd", "purpose" "entered by #6384ff582599e9d9aaadc7be# sample drawdown call", "businessfunctioncode" "drc", "typecode" "1031", "senderroutingnumber" "021214891", "sendername" "cross river bank", "senderreference" "w230093gg8s", "receiverroutingnumber" "026009593", "receivername" "bk amer nyc ", "originatingfi" { "idcode" "f", "identifier" "021214891", "name" "cross river bank", "address1" "400 kelby street", "address2" "fort lee nj 07024", "address3" "us" }, "originator" { "idcode" "d", "identifier" "2662824164", "name" "pmr corporation", "address1" "10431 howe drive", "address2" "shawnee mission ks 66206", "address3" "us" }, "beneficiaryfi" { "idcode" "f", "identifier" "021214891", "name" "cross river bank", "address1" "400 kelby street", "address2" "fort lee nj 07024", "address3" "us" }, "beneficiary" { "idcode" "d", "identifier" "2662824164", "name" "pmr corporation", "address1" "10431 howe drive", "address2" "shawnee mission ks 66206", "address3" "us" }, "originatortobeneficiary1" "1string", "originatortobeneficiary2" "2string", "originatortobeneficiary3" "3string", "originatortobeneficiary4" "4string", "beneficiaryreference" "testref", "wasreversed" false, "isinternational" false, "clientidentifier" "40708c24 7dee 49c3 b4d2 c48d876f1f5e", "createdat" "2023 01 09t09 29 11 9495462 05 00", "effectivedate" "2023 01 09t00 00 00 05 00", "originalpaymentid" "e201c363 1039 45cc 99c3 af8500eebb92", "partnerid" "cd9c12f4 7691 424a b38b af5b0134c611", "productid" "a68a0fa5 98fe 4cd5 b626 af5b0137e0cb", "lastmodifiedat" "2023 01 09t09 29 11 9651496 05 00", "postingcode" "ok" } successful posting of the payment triggers the wire payment received webhook event