Wire transfer

Relevant webhooks

For this endpoint be sure you have registered for these webhooks:

Wire.Payment.Sent

Wire.Payment.Received

Wire.Payment.Rejected

Wire.Payment.Canceled

API reference

Sends a single wire transfer payment.

Endpoint: /wires/v1/payments

POST

https://sandbox.crbcos.com/wires/v1/payments

Body Parameters

accountNumberstringrequired
Description
Originator account number
originatorobject
Description
Originator of the payment. Under the Bank Secrecy Act Travel Rule, information identifying the sender has to travel with the payment, and wires that arrive without it may be held for compliance review and returned to you for correction. The rule applies to transfers of $3,000 or more. We recommend supplying these details on every wire, so you do not have to make it conditional on the amount. By default, the originator on the outbound wire is either Cross River or the name of the account, depending on the configuration of your product. If you are providing the originator you must supply it in full.
- idCodestring
  Description
  Details of the financial institution sending the wire - Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.
- identifierstring
  Description
  Originator id
- namestring
  Description
  Originator name. Maximum 140 characters.
- postalAddressobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information and should be used instead of the deprecated address lines
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Details of the party sending the wire - Field of 35 characters usually used for the street address.
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Details of the party sending the wire - Field of 35 characters usually used for the city, state, and postal code. If address2 is supplied then address1 must also be supplied.
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Details of the party sending the wire - Field of 35 characters for any information, for example, country code or information related to the wire. If address3 is supplied then address2 must also be supplied.
businessFunctionCodestringrequired
Description
The business purpose of the wire transfer. The most common type is customer wire transfer (CTR) where the beneficiary isn't a bank. See the full list of codes and descriptions.
receiverRoutingNumberstringrequired
Description
The 9-digit Fedwire routing number of the financial institution receiving the wire drawdown request. The ABA directory provides financial institution routing numbers.
beneficiaryobjectrequired
Description
Entity receiving the funds
- idCodestringrequired
  Description
  Specifies the type of value in the identifier field that follows it. Maximum 1 character. For outbound payments, this field must contain a valid customer code, with the most common being "D" for demand deposit accounts. Please refer to the "Request and Response Code" section for the full list of valid customer codes.
- identifierstringrequired
  Description
  A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. Maximum 34 characters. For outbound payments, this is the beneficiary's account number.
- namestringrequired
  Description
  Beneficiary name. Maximum 140 characters.
- postalAddressobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information and should be used instead of the deprecated address lines
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address.
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code. If address2 is supplied then address1 must also be supplied.
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire. If address3 is supplied then address2 must also be supplied.
beneficiaryFiobject
Description
Bank receiving the wire transfer
- idCodestringrequired
  Description
  Specifies the type of value in the identifier field that follows it. Maximum 1 character. For outbound payments, the value for the beneficiary FI is F to indicate the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field. Required if idCode is not "F" - Fed routing number.
- identifierstringrequired
  Description
  A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. Maximum 34 characters. For outbound payments, enter the bank Fed routing number for the beneficiary FI. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field. Required if idCode is not "F" - Fed routing number.
- namestringrequired
  Description
  Beneficiary financial institution name. Maximum 140 characters. Required if idCode is not "F" - Fed routing number.
- postalAddressobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information and should be used instead of the deprecated address lines
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address. Must include address1 if IdCode is not a BIC.
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code. If address2 is supplied then address1 must also be supplied.
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire. If address3 is supplied then address2 must also be supplied.
intermediaryFiobject
Description
Intermediary bank involved in the transaction. Required when sending an international payment.
- idCodestringrequired
  Description
  Specifies the type of value in the identifier field that follows it. Maximum 1 character.
- identifierstringrequired
  Description
  A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. Maximum 34 characters. In this object, enter an identifier for the intermediary bank involved with the wire transaction. If the idCode is a Fed routing number, the identifier must be a valid Fed participant.
- namestringrequired
  Description
  Intermediary financial institution name. Maximum 140 characters.
- postalAddressobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information and should be used instead of the deprecated address lines
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address. Must include address1 if IdCode is not a BIC.
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code. If address2 is supplied then address1 must also be supplied.
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire. If address3 is supplied then address2 must also be supplied.
beneficiaryReferencestring
Description
Optional field for additional information. 35 characters maximum.
originatorToBeneficiary1string
Description
Field for additional information from the originator to the beneficiary. 35 characters maximum. You can add information in up to 4 originator to beneficiary fields (originatorToBeneficiary1, originatorToBeneficiary2, originatorToBeneficiary3, originatorToBeneficiary4).
amountintegerrequired
Description
Dollar amount of wire transfer in positive integral cents. For example, write $1.00 as 100.
purposestringrequired
Description
Reason for the wire transfer, such as "daily settlement." Also use this field if you submit multiple wires for the same amount, such as "1 of 2, 2 of 2." This data is not included with the outgoing FedWire message. Maxmum 50 characters.
clientIdentifierstring
Description
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.

Response

idstring
Description
The payment ID. First appears in the initial response to the originate a payment request. This ID is in GUID format.
accountNumberstring
Description
Cross River Account number. In Cross River, depending on the account type, the number of digits will vary. The first digit indicates the kind of account.
coreTransactionIdstring
Description
Internal Cross River unique ID for the transaction
referenceIdstring
Description
Unique Cross River reference ID for the payment
fedBatchIdstring
Description
Unique identifier in GUID format for the Federal Reserve batch the payment went out on (or came in on for inbound payments)
fedBatchSequenceinteger
Description
Sequence number of payment in batch
directionstring
Description
Inbound or outbound
paymentTypestring
Description
Transfer, Drawdown, DrawdownResponse, ServiceMessage, Reversal
sourcestring
Description
Method used to send payment instructions: Phone, fax, email, file, API, partner portal, Ops portal.
statusstring
Description
Payment status: Created, Pending, Hold, Batched, Processing, Completed, Rejected, Canceled, Blocked
postingstring
Description
Posting status: Pending, Posted, Failed, Canceled
rejectionReasonstring
Description
Rejected because: - OfacCancelUnableToDetermine - OfacConfirmed - OfacUnconfirmed - PaymentPostingRejected: the debit from the originating account failed. See postingCode for the reason, for example NSF or RES - Other
blockedReasonstring
Description
Blocked because: OfacMatch, Other
partnerAuthorizationstring
Description
Partner authorization for out-of-band payment requests: NotRequired, Pending , Approved, Canceled
authorizedAtstring
Description
Date and time the wire was authorized. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
authorizedByIdstring
Description
Cross River user ID of the partner user who authorizes the wire
authorizedByNamestring
Description
Cross River username of the partner user who authorizes the wire
partnerAuthorization2string
Description
Second partner authorization for out-of-band payment requests: NotRequired, Pending , Approved, Canceled
authorizedAt2string
Description
Date and time the wire was authorized. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
authorizedById2string
Description
Cross River user ID of the partner user who authorizes the wire
authorizedByName2string
Description
Cross River username of the partner user who authorizes the wire
amountinteger
Description
Dollar amount of wire transfer in positive integral cents. For example, write $1.00 as 100.
currencystring
Description
Currency of funds transfer
purposestring
Description
Reason for the wire transfer, such as "daily settlement." Also use this field if you submit multiple wires for the same amount, such as "1 of 2, 2 of 2." This data is not included with the outgoing FedWire message.
imadstring
Description
Input Messaging Accountability Data. A combination of a date, source identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application. Unique to the payment.
omadstring
Description
Output Messaging Accountability Data. A combination of a date, destination identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application.
businessFunctionCodestring
Description
The business purpose of the wire transfer. The most common type is customer wire transfer (CTR) where the beneficiary isn't a bank. See the full list of codes and descriptions.
typeCodestring
Description
The type code value provides information about the type of wire transfer sent (type code, first 2 digits) and more details about the transfer (subtype code, second 2 digits).
senderRoutingNumberstring
Description
Fedwire routing number for the sender's bank
senderNamestring
Description
Entity sending the wire
senderReferencestring
Description
Sender's assigned reference number
receiverRoutingNumberstring
Description
The 9-digit Fedwire routing number of the financial institution receiving the wire drawdown request. The ABA directory provides financial institution routing numbers.
receiverNamestring
Description
Name of the FI receiving the funds
originatingFiobject
Description
Details of the financial institution sending the wire
- idCodestring
  Description
  Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.
- identifierstring
  Description
  Identifier at the financial institution sending the wire
- namestring
  Description
  Name of the originating financial institution
- postalAddressInfoobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire
originatorobject
Description
Details of the party sending the wire
- idCodestring
  Description
  Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.
- identifierstring
  Description
  Identifier for the party sending the wire. For outbound payments where originator details are submitted with the payment request, this is the customer account number. Otherwise, the system automatically populates this field.
- namestring
  Description
  Originator name.
- postalAddressInfoobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire
intermediaryFiobject
Description
Details of any intermediary bank involved in the wire transaction. Not all wire transfers use an intermediary FI.
- idCodestring
  Description
  Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.
- identifierstring
  Description
  Identifier for the intermediary bank involved with the wire transaction.
- namestring
  Description
  Intermediary financial institution name.
- postalAddressInfoobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire
beneficiaryFiobject
Description
Details of the financial institution receiving the wire
- idCodestring
  Description
  Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes. For outbound payments, the value for the beneficiary FI is F to indicate the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field.
- identifierstring
  Description
  Identifier for the bank receiving the wire. For outbound payments, this is the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field.
- namestring
  Description
  Beneficiary financial institution name. Maximum 140 characters.
- postalAddressInfoobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire
beneficiaryobject
Description
Details of the party receiving the wire
- idCodestring
  Description
  Identifier code for the party receiving the wire. For outbound payments, this is "D" to indicate a deposit account.
- identifierstring
  Description
  Identifier for the party receiving the wire. For outbound payments, this is the beneficiary's account number.
- namestring
  Description
  Beneficiary name. Maximum 140 characters.
- postalAddressInfoobject
  Description
  Postal address details of the party involved - this is the NEW ISO20022 format for address information
  - adrLine1stringrequired
    Description
    Max 35 chars
  - adrLine2string
    Description
    Max 35 chars. If adrLine2 is provided, then adrLine1 must not be blank
  - countrystringrequired
    Description
    2 character country ISO country code. For example US, GB
  - statestring
    Description
    2-char state. For example NY, FL
  - postalCodestring
    Description
    Max 15 chars
  - citystringrequired
    Description
    Max 35 chars
- address1string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the street address
- address2string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters usually used for the city, state, and postal code
- address3string
  Description
  DEPRECATED - Use the PostalAddress object instead. Field of 35 characters for any information, for example, country code or information related to the wire
originatorToBeneficiary1string
Description
Field for additional information from the originator to the beneficiary.
beneficiaryReferencestring
Description
Optional field for additional information. 35 characters maximum.
receiptDatestring
Description
Month and day the wire was received in the format mmdd
receiptTimestring
Description
Time the wire was received, in the format hhmm
wasReversedboolean
Description
True if the payment was reversed, otherwise false
isInternationalboolean
Description
True if the payment is international, otherwise false
clientIdentifierstring
Description
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
createdAtstring
Description
Date and time the payment was created in the system. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
releasedAtstring
Description
Date and time the payment was released in a distribution to the Fed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
processedAtstring
Description
Date and time the payment was processed by Cross River. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm].
canceledAtstring
Description
Date and time the payment was canceled
rejectedAtstring
Description
Date and time the payment was rejected. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
blockedAtstring
Description
Date and time the payment was blocked by BSA/AML. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
effectiveDatestring
Description
Business date on which the payment is effective
completedAtstring
Description
Date and time the payment was systemically completed. This can only occur after the payment has successfully posted to the account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
postedAtstring
Description
Date and time the payment was posted to the Cross River account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
originalPaymentIdstring
Description
Payment ID of a previously sent wire that was reversed. Otherwise, the same as the payment ID.
partnerIdstring
Description
Your unique ID in the Cross River system. This ID is in GUID format.
productIdstring
Description
ID in GUID format of your specific product type on which the account is based. Provided by Cross River. In this case, the Cross River account involved in the payment. More about Product IDs.
lastModifiedAtstring
Description
Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
postingCodestring
Description
Includes OK (posted), RES (account restricted), NSF (insufficient funds in the account sending the wire)

curl

curl --location 'https://sandbox.crbcos.com/wires/v1/payments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "accountNumber": "2955057589",
    "businessFunctionCode": "CTR",
    "receiverRoutingNumber": "026009593",
    "beneficiary": {
        "idCode": "D",
        "identifier": "316840684",
        "name": "Stewie Griffin",
        "postalAddress": {
            "adrLine1": "31 Spooner St",
            "city": "Quahog",
            "state": "RI",
            "postalCode": "33030",
            "country": "US"
        }
    },
    "beneficiaryReference": "Gift",
    "originatorToBeneficiary1": "Happy Birthday",
    "amount": 15000,
    "purpose": "Testing",
    "clientIdentifier": "05d73490-65ac-4725-98b6-cbf8252e52fe"
}

'

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'sandbox.crbcos.com',
  'path': '/wires/v1/payments',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData =  "{\r\n    \"accountNumber\": \"2955057589\",\r\n    \"businessFunctionCode\": \"CTR\",\r\n    \"receiverRoutingNumber\": \"026009593\",\r\n    \"beneficiary\": {\r\n        \"idCode\": \"D\",\r\n        \"identifier\": \"316840684\",\r\n        \"name\": \"Stewie Griffin\",\r\n        \"postalAddress\": {\r\n            \"adrLine1\": \"31 Spooner St\",\r\n            \"city\": \"Quahog\",\r\n            \"state\": \"RI\",\r\n            \"postalCode\": \"33030\",\r\n            \"country\": \"US\"\r\n        }\r\n    },\r\n    \"beneficiaryReference\": \"Gift\",\r\n    \"originatorToBeneficiary1\": \"Happy Birthday\",\r\n    \"amount\": 15000,\r\n    \"purpose\": \"Testing\",\r\n    \"clientIdentifier\": \"05d73490-65ac-4725-98b6-cbf8252e52fe\"\r\n}\r\n\r\n";

req.write(postData);

req.end();

python

import requests

url = "https://sandbox.crbcos.com/wires/v1/payments"

payload = "{\r\n    \"accountNumber\": \"2955057589\",\r\n    \"businessFunctionCode\": \"CTR\",\r\n    \"receiverRoutingNumber\": \"026009593\",\r\n    \"beneficiary\": {\r\n        \"idCode\": \"D\",\r\n        \"identifier\": \"316840684\",\r\n        \"name\": \"Stewie Griffin\",\r\n        \"postalAddress\": {\r\n            \"adrLine1\": \"31 Spooner St\",\r\n            \"city\": \"Quahog\",\r\n            \"state\": \"RI\",\r\n            \"postalCode\": \"33030\",\r\n            \"country\": \"US\"\r\n        }\r\n    },\r\n    \"beneficiaryReference\": \"Gift\",\r\n    \"originatorToBeneficiary1\": \"Happy Birthday\",\r\n    \"amount\": 15000,\r\n    \"purpose\": \"Testing\",\r\n    \"clientIdentifier\": \"05d73490-65ac-4725-98b6-cbf8252e52fe\"\r\n}\r\n\r\n"
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://sandbox.crbcos.com/wires/v1/payments")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\r\n    \"accountNumber\": \"2955057589\",\r\n    \"businessFunctionCode\": \"CTR\",\r\n    \"receiverRoutingNumber\": \"026009593\",\r\n    \"beneficiary\": {\r\n        \"idCode\": \"D\",\r\n        \"identifier\": \"316840684\",\r\n        \"name\": \"Stewie Griffin\",\r\n        \"postalAddress\": {\r\n            \"adrLine1\": \"31 Spooner St\",\r\n            \"city\": \"Quahog\",\r\n            \"state\": \"RI\",\r\n            \"postalCode\": \"33030\",\r\n            \"country\": \"US\"\r\n        }\r\n    },\r\n    \"beneficiaryReference\": \"Gift\",\r\n    \"originatorToBeneficiary1\": \"Happy Birthday\",\r\n    \"amount\": 15000,\r\n    \"purpose\": \"Testing\",\r\n    \"clientIdentifier\": \"05d73490-65ac-4725-98b6-cbf8252e52fe\"\r\n}\r\n\r\n"

response = https.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/wires/v1/payments"
  method := "POST"

  payload := strings.NewReader(`{
    "accountNumber": "2955057589",
    "businessFunctionCode": "CTR",
    "receiverRoutingNumber": "026009593",
    "beneficiary": {
        "idCode": "D",
        "identifier": "316840684",
        "name": "Stewie Griffin",
        "postalAddress": {
            "adrLine1": "31 Spooner St",
            "city": "Quahog",
            "state": "RI",
            "postalCode": "33030",
            "country": "US"
        }
    },
    "beneficiaryReference": "Gift",
    "originatorToBeneficiary1": "Happy Birthday",
    "amount": 15000,
    "purpose": "Testing",
    "clientIdentifier": "05d73490-65ac-4725-98b6-cbf8252e52fe"
}

`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
    "id": "2c17d36d-cb70-420d-9a16-b30100ddd39c",
    "accountNumber": "2955057589",
    "coreTransactionId": "5449f04c-9dce-4d54-9873-b30100ddd39c",
    "referenceId": "FT86171667Z",
    "direction": "Outbound",
    "paymentType": "Transfer",
    "source": "Api",
    "status": "Created",
    "posting": "Pending",
    "partnerAuthorization": "NotRequired",
    "partnerAuthorization2": "NotRequired",
    "enteredById": "b799951d47eb410d92b9da901b8ffa69",
    "amount": 15000,
    "currency": "usd",
    "purpose": "Testing",
    "businessFunctionCode": "CTR",
    "typeCode": "1000",
    "senderRoutingNumber": "021214891",
    "senderName": "CROSS RIVER BANK",
    "senderReference": "FT86171667Z",
    "receiverRoutingNumber": "026009593",
    "receiverName": "BK AMER NYC       ",
    "originatingFi": {
        "idCode": "F",
        "identifier": "021214891",
        "name": "CROSS RIVER BANK",
        "address1": "400 KELBY STREET",
        "address2": "FORT LEE, NJ",
        "address3": "US"
    },
    "originator": {
        "identifier": "2955057589",
        "name": "ORIGINATOR NAME"
    },
    "beneficiary": {
        "idCode": "D",
        "identifier": "316840684",
        "name": "Stewie Griffin",
        "address1": "31 Spooner St",
        "address2": "Quahog RI 33030",
        "address3": "US"
    },
    "originatorToBeneficiary1": "HAPPY BIRTHDAY",
    "beneficiaryReference": "GIFT",
    "wasReversed": false,
    "isInternational": false,
    "clientIdentifier": "05d73490-65ac-4725-98b6-cbf8252e52fe",
    "createdAt": "2025-06-19T09:27:38.7553761-04:00",
    "effectiveDate": "2025-06-19T00:00:00-04:00",
    "originalPaymentId": "2c17d36d-cb70-420d-9a16-b30100ddd39c",
    "partnerId": "1101a33d-fbd9-4b9e-b169-b29500f12407",
    "productId": "29f3022a-ccfc-42eb-aa8f-b29500f13d00",
    "lastModifiedAt": "2025-06-19T09:27:38.7553761-04:00",
    "postingCode": "OK",
    "investigated": false,
    "isoPaymentType": "CustomerCreditTransfer"
}

403

{
    "errors": [
        {
            "code": 3001,
            "message": "Origination payment amount exceeds user permissions"
        }
    ]
}

Validation Rules

Originator Requirement

If Originator is null or empty, the system will use the configured account/product originator.

If the configured account/product originator contains any of the following ID codes, the request will be rejected:

"U" (CHIPS Identifier)

"C" (CHIPS Participant)

"F" (Fed Routing Number)

Error Message: Account or product configuration error.

Intermediary FI and Beneficiary FI Uniqueness

If both are specified with the same identifier, the request will be rejected.

Error Message: IntermediaryFi and BeneficiaryFi cannot be identical.

Beneficiary Validation

Must be validated as a person or organization.

Errors follow the person/organization validation rules.

Beneficiary FI Validation

Must be validated as a financial institution.

Errors follow the financial institution validation rules.

Intermediary FI Validation

Must be validated as a financial institution.

Errors follow the financial institution validation rules.

Default Values

Beneficiary FI (if not explicitly provided — no ID Code or Identifier specified)

Derived from the Receiver Routing Number:

ID Code: "F"

Identifier: Routing number

Name: Participant’s customer name

Address1: Participant’s city and state