Update a funds transfer method

PATCH 
https://api.sandbox.magfi.net/v2/funds-transfer-methods/:funds-transfer-method-id

Update an existing funds transfer method

Request

Path Parameters

funds-transfer-method-id uuidrequired

ID of the funds transfer method to update

application/json

Bodyrequired

labelstring

User-defined label for the transfer method

contactNamestring

Name of contact associated with transfer method

contactEmailemail

Email of contact associated with transfer method

Responses

200

Funds transfer method updated successfully

application/json

Schema

Schema

iduuid
accountIduuid
ID of the associated account
fundsTransferTypestring
Type of funds transfer (ACH, CREDIT_CARD, WIRE, WIRE_INTERNATIONAL, CHECK)
Possible values: [ACH, CREDIT_CARD, WIRE, WIRE_INTERNATIONAL, CHECK]
transferDirectionstring
Direction of the transfer (INCOMING or OUTGOING)
Possible values: [INCOMING, OUTGOING]
Default value: INCOMING
labelstring
User-defined label for the transfer method
inactiveboolean
Whether the transfer method is inactive
Default value: false
bankNamestring
Name of the bank
bankAccountNamestring
Name on the bank account
bankAccountTypestring
Type of bank account (CHECKING or SAVINGS)
Possible values: [CHECKING, SAVINGS]
routingNumberstring
Bank routing number
last4string
Last 4 digits of account number
swiftCodestring
SWIFT code for international transfers
ibanstring
International Bank Account Number
creditCardNamestring
Name on credit card
creditCardPostalCodestring
Postal code associated with credit card
creditCardTypestring
Type of credit card (VISA, MASTERCARD, AMEX, DISCOVER)
Possible values: [VISA, MASTERCARD, AMEX, DISCOVER]
creditCardExpirationDatestring
Expiration date of credit card in MM/YY format
creditCardBinstring
Bank Identification Number (first 6-8 digits of card)
creditCardFundingTypestring
Funding type of card (CREDIT, DEBIT, PREPAID, UNKNOWN)
Possible values: [CREDIT, DEBIT, PREPAID, UNKNOWN]
checkPayeestring
Name of check payee
contactNamestring
Name of contact associated with transfer method
contactEmailemail
Email of contact associated with transfer method
createdAtdate-time
updatedAtdate-time

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fundsTransferType": "ACH",
  "transferDirection": "INCOMING",
  "label": "string",
  "inactive": false,
  "bankName": "string",
  "bankAccountName": "string",
  "bankAccountType": "CHECKING",
  "routingNumber": "string",
  "last4": "string",
  "swiftCode": "string",
  "iban": "string",
  "creditCardName": "string",
  "creditCardPostalCode": "string",
  "creditCardType": "VISA",
  "creditCardExpirationDate": "string",
  "creditCardBin": "string",
  "creditCardFundingType": "CREDIT",
  "checkPayee": "string",
  "contactName": "string",
  "contactEmail": "user@example.com",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}

400

Bad Request - Invalid input data

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Invalid input data",
  "description": "The request data did not pass validation",
  "code": "INVALID_INPUT"
}

401

Unauthorized - Invalid or missing authentication token

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Unauthorized",
  "description": "Invalid, expired or missing bearer token",
  "code": "UNAUTHORIZED"
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Forbidden",
  "description": "You don't have permission to access this resource",
  "code": "FORBIDDEN"
}

404

Not Found - Resource not found

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource not found",
  "description": "The requested resource could not be found",
  "code": "NOT_FOUND"
}

409

Conflict - Resource already exists or state conflict

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Resource conflict",
  "description": "The resource already exists or is in an invalid state",
  "code": "CONFLICT"
}

422

Unprocessable Entity - Validation error

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (auto)

{
  "message": "Validation error",
  "description": "The request data failed validation rules",
  "code": "VALIDATION_ERROR"
}

• javascript
• python
• curl
• rust
• go
• java
• ruby

• FETCH
• JQUERY
• XHR

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");

const raw = JSON.stringify({
  "label": "string",
  "contactName": "string",
  "contactEmail": "user@example.com"
});

const requestOptions = {
  method: "PATCH",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.sandbox.magfi.net/v2/funds-transfer-methods/:funds-transfer-method-id", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Request Collapse all

Base URL

https://api.sandbox.magfi.net

Parameters

funds-transfer-method-id — pathrequired

Body required

{
  "label": "string",
  "contactName": "string",
  "contactEmail": "user@example.com"
}

ResponseClear

Click the Send API Request button above and see the response here!