POST
/
payment-transfers
/
ach
import Fiatwebservices from 'fiatwebservices';

const client = new Fiatwebservices({
  apiKey: process.env['FWS_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const ach = await client.transfer.ach.create({ message: '<xml/>' });

  console.log(ach.id);
}

main();
{
  "id": "019545cd-c9d1-797d-b2e8-e704c3109311",
  "organizationId": "019545cd-c9d1-797d-b2e8-e704c3109311",
  "createdAt": "2025-02-27",
  "direction": "credit",
  "messageId": "1234",
  "type": "sepa",
  "initiatingPartyId": "019545cd-c9d1-797d-b2e8-e704c3109311",
  "creationDate": "2025-02-27",
  "categoryPurposeCode": "1234",
  "paymentInformationId": "1234"
}

Body

application/json
​
message
string
required

The XML message of the transfer.

Example:

"<xml/>"

Response

200
application/json
The payment transfer creation response.

The payment transfer object.

​
id
string
required

The internal ID of the payment transfer.

Example:

"019545cd-c9d1-797d-b2e8-e704c3109311"

​
organizationId
string
required

The internal ID of the organization.

Example:

"019545cd-c9d1-797d-b2e8-e704c3109311"

​
createdAt
string
required

The date and time when the payment transfer was created

Example:

"2025-02-27"

​
direction
enum<string>
required

The direction of the payment transfer.

Available options:
debit,
credit
Example:

"credit"

​
type
enum<string>
required

The payment rail type of the transfer.

Available options:
swift,
sepa,
ach,
rtp
Example:

"sepa"

​
initiatingPartyId
string
required

The initiating party of the payment transfer.

Example:

"019545cd-c9d1-797d-b2e8-e704c3109311"

​
messageId
string | null

The message ID of the payment transfer. Used to identify the message.

Example:

"1234"

​
creationDate
string | null

The date and time when the payment transfer was created

Example:

"2025-02-27"

​
categoryPurposeCode
string | null

The category purpose code of the payment transfer.

Example:

"1234"

​
paymentInformationId
string | null

The information ID of the payment transfer. Used to identify the entire transfer.

Example:

"1234"