Skip to content
API Reference/
/
Delete carrier payment me...

MVMNT API (1.0.0)

The MVMNT API enables you to automate freight brokerage workflows by integrating directly with our Transportation Management System.

Authentication

OAuth 2.0 client credentials flow. See Authentication Guide for details.

Token Endpoint

POST https://api.mvmnt.io/oauth2/token

Request

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Example Request

curl -X POST https://api.mvmnt.io/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Success Response

Status: 200 OK

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Response Fields:

  • access_token: JWT Bearer token to use for API requests
  • token_type: Always Bearer
  • expires_in: Token lifetime in seconds (3600 = 1 hour)
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://docs.mvmnt.io
MVMNT Support
support@mvmnt.io
License
Proprietary
Languages
Servers
Mock server
https://docs.mvmnt.io/_mock/apis/openapi
Production
https://api.mvmnt.io/v1

Carriers

Carrier management operations

Operations

Carrier Contacts

Carrier contact management operations

Operations

Carrier Factors

Carrier factor (factoring company) management operations

Operations

Carrier Payment Methods

Carrier payment method management operations

Operations

Filter carrier payment methods

Request

Query carrier payment methods using flexible filter criteria with AND/OR logic.

By default, only non-deleted payment methods are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.

Carrier payment methods define how and where payments are sent for a specific carrier.

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(CarrierPaymentMethodFilter)

Filter criteria (optional - omit to return all carrier payment methods).

Note: deletedAt automatically defaults to { isNull: true } unless explicitly overridden.

Example: {"and":[{"carrierId":{"equalTo":"770e8400-e29b-41d4-a716-446655440000"}},{"paymentRecipientType":{"equalTo":"DIRECT"}},{"isPreferred":{"equalTo":true}}]}
pageSizeinteger[ 1 .. 250 ]

Number of results per page

Default 50
Example: 50
cursorstring

Pagination cursor for next page

curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-payment-methods/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "and": [
        {
          "carrierId": {
            "equalTo": "770e8400-e29b-41d4-a716-446655440000"
          }
        },
        {
          "paymentRecipientType": {
            "equalTo": "DIRECT"
          }
        },
        {
          "isPreferred": {
            "equalTo": true
          }
        }
      ]
    },
    "pageSize": 50
  }'

Responses

Filtered carrier payment methods with pagination

Bodyapplication/json
dataArray of objects(CarrierPaymentMethod)required
data[].​idstring(uuid)read-onlyrequired

Unique carrier payment method identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​carrierIdstring(uuid)read-onlyrequired

Carrier profile ID (read-only after creation).

This field cannot be changed after the payment method is created.

Example: "770e8400-e29b-41d4-a716-446655440000"
data[].​carrierobject(CarrierReference)required

Carrier profile reference with full details

data[].​carrier.​idstring(uuid)required

Carrier UUID

Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​carrier.​keystring or null<= 512 characters

Client-defined reference ID if set

Example: "ERP-CARRIER-SWIFT"
data[].​carrier.​namestringrequired

Carrier company name

Example: "Swift Transportation"
data[].​carrier.​phoneNumberstring or null

Primary phone number

Example: "+1-555-987-6543"
data[].​carrier.​emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
data[].​carrier.​createdAtstring(date-time)required

When the carrier was created

Example: "2025-01-15T10:00:00Z"
data[].​carrier.​updatedAtstring(date-time)required

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
data[].​carrier.​deletedAtstring or null(date-time)

When the carrier was soft deleted (null if active)

Example: null
data[].​paymentRecipientTypestring(PaymentRecipientType)required

Who receives the payment.

  • DIRECT: Payment goes directly to the carrier (carrierFactorId must be null)
  • FACTOR: Payment goes to a factoring company (carrierFactorId is required)
Enum"DIRECT""FACTOR"
data[].​paymentMethodTypestring(PaymentMethodType)required

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
data[].​statusstring or null

Payment method status

Example: "ACTIVE"
data[].​isPreferredboolean or null

Whether this is the preferred payment method for the carrier

Example: true
data[].​emailstring or null(email)

Email address for payment notifications

Example: "payments@carrier.com"
data[].​phonestring or null

Phone number for payment contact

Example: "+1-555-123-4567"
data[].​companyNamestring or null

Company name for this payment method (may differ from carrier name)

Example: "Carrier Payments LLC"
data[].​usernamestring or null

Username for payment platforms (e.g., Zelle, Venmo)

Example: "carrier_payments"
data[].​bankNamestring or null

Bank name

Example: "Chase Bank"
data[].​bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
data[].​accountNamestring or null

Bank account holder name

Example: "Carrier Transport Inc"
data[].​accountNumberstring or null

Bank account number (masked in responses)

Example: "****1234"
data[].​abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
data[].​wirestring or null

Wire transfer routing number

Example: "026009593"
data[].​swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
data[].​eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
data[].​eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
data[].​clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
data[].​currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
data[].​carrierFactorCarrierFactorReference (object) or null

Factoring company reference (required when paymentRecipientType is FACTOR).

When paymentRecipientType is DIRECT, this must be null.

Any of:

Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.

data[].​paymentTermPaymentTermReference (object) or null

Payment terms for this payment method

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

data[].​createdAtstring(date-time)read-onlyrequired

When the payment method was created

Example: "2025-01-15T10:00:00Z"
data[].​updatedAtstring(date-time)read-onlyrequired

When the payment method was last updated

Example: "2025-01-15T14:30:00Z"
data[].​deletedAtstring or null(date-time)read-only

When the payment method was soft deleted (null if active)

Example: null
data[].​deletedByUserReference (object) or nullread-only

User who deleted this payment method

Any of:

Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.

Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.

pageInfoobject(PaginationInfo)required
pageInfo.​pageSizeintegerrequired

Number of items per page

Example: 50
pageInfo.​hasNextPagebooleanrequired

Whether there are more pages

Example: true
pageInfo.​hasPreviousPageboolean

Whether there are previous pages

Example: false
pageInfo.​endCursorstring or null

Cursor for the next page (null if no next page)

Example: "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
Response
application/json
{
  "data": [
    { … }
  ],
  "pageInfo": {
    "pageSize": 50,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Create carrier payment method

Request

Create a new carrier payment method.

Payment Recipient Type Constraints:

  • DIRECT: Payment goes to carrier directly. carrierFactorId must be null or omitted.
  • FACTOR: Payment goes to factoring company. carrierFactorId is required.

Important: The carrierId cannot be changed after creation.

Security
BearerAuth
Bodyapplication/jsonrequired
carrierIdstring(uuid)required

Carrier profile ID.

IMPORTANT: This field cannot be changed after creation.

Example: "770e8400-e29b-41d4-a716-446655440000"
paymentRecipientTypestring(PaymentRecipientType)required

Who receives the payment.

  • DIRECT: carrierFactorId must be null or omitted
  • FACTOR: carrierFactorId is required
Enum"DIRECT""FACTOR"
paymentMethodTypestring(PaymentMethodType)required

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
statusstring

Payment method status

Example: "ACTIVE"
isPreferredboolean

Whether this is the preferred payment method

Example: true
emailstring(email)

Email address for payment notifications

Example: "payments@carrier.com"
phonestring

Phone number for payment contact

Example: "+1-555-123-4567"
companyNamestring

Company name for this payment method

Example: "Carrier Payments LLC"
usernamestring

Username for payment platforms

Example: "carrier_payments"
bankNamestring

Bank name

Example: "Chase Bank"
bankAddressstring

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring

Bank account holder name

Example: "Carrier Transport Inc"
accountNumberstring

Bank account number

Example: "1234567890"
abaAchstring

ABA/ACH routing number

Example: "021000021"
wirestring

Wire transfer routing number

Example: "026009593"
swiftCodestring

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring

EFT transit number (Canadian banking)

Example: "00010"
clabestring

CLABE number (Mexican banking)

Example: "012180001234567897"
currencystring

Preferred currency code (ISO 4217)

Example: "USD"
carrierFactorIdstring(uuid)

Carrier factor (factoring company) ID.

Constraint: Required when paymentRecipientType is FACTOR, must be null when DIRECT.

Example: "550e8400-e29b-41d4-a716-446655440000"
paymentTermIdstring(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-payment-methods \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrierId": "770e8400-e29b-41d4-a716-446655440000",
    "paymentRecipientType": "DIRECT",
    "paymentMethodType": "ACH",
    "isPreferred": true,
    "bankName": "Chase Bank",
    "accountName": "Carrier Transport Inc",
    "accountNumber": "1234567890",
    "abaAch": "021000021",
    "currency": "USD"
  }'

Responses

Carrier payment method created successfully

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier payment method identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
carrierIdstring(uuid)read-onlyrequired

Carrier profile ID (read-only after creation).

This field cannot be changed after the payment method is created.

Example: "770e8400-e29b-41d4-a716-446655440000"
carrierobject(CarrierReference)required

Carrier profile reference with full details

carrier.​idstring(uuid)required

Carrier UUID

Example: "550e8400-e29b-41d4-a716-446655440000"
carrier.​keystring or null<= 512 characters

Client-defined reference ID if set

Example: "ERP-CARRIER-SWIFT"
carrier.​namestringrequired

Carrier company name

Example: "Swift Transportation"
carrier.​phoneNumberstring or null

Primary phone number

Example: "+1-555-987-6543"
carrier.​emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
carrier.​createdAtstring(date-time)required

When the carrier was created

Example: "2025-01-15T10:00:00Z"
carrier.​updatedAtstring(date-time)required

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
carrier.​deletedAtstring or null(date-time)

When the carrier was soft deleted (null if active)

Example: null
paymentRecipientTypestring(PaymentRecipientType)required

Who receives the payment.

  • DIRECT: Payment goes directly to the carrier (carrierFactorId must be null)
  • FACTOR: Payment goes to a factoring company (carrierFactorId is required)
Enum"DIRECT""FACTOR"
paymentMethodTypestring(PaymentMethodType)required

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
statusstring or null

Payment method status

Example: "ACTIVE"
isPreferredboolean or null

Whether this is the preferred payment method for the carrier

Example: true
emailstring or null(email)

Email address for payment notifications

Example: "payments@carrier.com"
phonestring or null

Phone number for payment contact

Example: "+1-555-123-4567"
companyNamestring or null

Company name for this payment method (may differ from carrier name)

Example: "Carrier Payments LLC"
usernamestring or null

Username for payment platforms (e.g., Zelle, Venmo)

Example: "carrier_payments"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Carrier Transport Inc"
accountNumberstring or null

Bank account number (masked in responses)

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
carrierFactorCarrierFactorReference (object) or null

Factoring company reference (required when paymentRecipientType is FACTOR).

When paymentRecipientType is DIRECT, this must be null.

Any of:

Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.

paymentTermPaymentTermReference (object) or null

Payment terms for this payment method

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

createdAtstring(date-time)read-onlyrequired

When the payment method was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the payment method was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the payment method was soft deleted (null if active)

Example: null
deletedByUserReference (object) or nullread-only

User who deleted this payment method

Any of:

Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.

Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.

Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carrierId": "770e8400-e29b-41d4-a716-446655440000",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "paymentRecipientType": "DIRECT",
  "paymentMethodType": "ACH",
  "status": "ACTIVE",
  "isPreferred": true,
  "email": "payments@carrier.com",
  "phone": "+1-555-123-4567",
  "companyName": "Carrier Payments LLC",
  "username": "carrier_payments",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Carrier Transport Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "carrierFactor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-FACTOR-001",
    "companyName": "Capital Factoring Services Inc",
    "email": "accounting@capitalfactoring.com",
    "phoneNumber": "+1-555-234-5678",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "deletedBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  }
}

Get carrier payment method

Request

Retrieve a single carrier payment method by its unique identifier.

Returns full details including banking information and associated carrier/factor references.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-payment-methods/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier payment method found

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier payment method identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
carrierIdstring(uuid)read-onlyrequired

Carrier profile ID (read-only after creation).

This field cannot be changed after the payment method is created.

Example: "770e8400-e29b-41d4-a716-446655440000"
carrierobject(CarrierReference)required

Carrier profile reference with full details

carrier.​idstring(uuid)required

Carrier UUID

Example: "550e8400-e29b-41d4-a716-446655440000"
carrier.​keystring or null<= 512 characters

Client-defined reference ID if set

Example: "ERP-CARRIER-SWIFT"
carrier.​namestringrequired

Carrier company name

Example: "Swift Transportation"
carrier.​phoneNumberstring or null

Primary phone number

Example: "+1-555-987-6543"
carrier.​emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
carrier.​createdAtstring(date-time)required

When the carrier was created

Example: "2025-01-15T10:00:00Z"
carrier.​updatedAtstring(date-time)required

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
carrier.​deletedAtstring or null(date-time)

When the carrier was soft deleted (null if active)

Example: null
paymentRecipientTypestring(PaymentRecipientType)required

Who receives the payment.

  • DIRECT: Payment goes directly to the carrier (carrierFactorId must be null)
  • FACTOR: Payment goes to a factoring company (carrierFactorId is required)
Enum"DIRECT""FACTOR"
paymentMethodTypestring(PaymentMethodType)required

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
statusstring or null

Payment method status

Example: "ACTIVE"
isPreferredboolean or null

Whether this is the preferred payment method for the carrier

Example: true
emailstring or null(email)

Email address for payment notifications

Example: "payments@carrier.com"
phonestring or null

Phone number for payment contact

Example: "+1-555-123-4567"
companyNamestring or null

Company name for this payment method (may differ from carrier name)

Example: "Carrier Payments LLC"
usernamestring or null

Username for payment platforms (e.g., Zelle, Venmo)

Example: "carrier_payments"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Carrier Transport Inc"
accountNumberstring or null

Bank account number (masked in responses)

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
carrierFactorCarrierFactorReference (object) or null

Factoring company reference (required when paymentRecipientType is FACTOR).

When paymentRecipientType is DIRECT, this must be null.

Any of:

Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.

paymentTermPaymentTermReference (object) or null

Payment terms for this payment method

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

createdAtstring(date-time)read-onlyrequired

When the payment method was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the payment method was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the payment method was soft deleted (null if active)

Example: null
deletedByUserReference (object) or nullread-only

User who deleted this payment method

Any of:

Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.

Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.

Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carrierId": "770e8400-e29b-41d4-a716-446655440000",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "paymentRecipientType": "DIRECT",
  "paymentMethodType": "ACH",
  "status": "ACTIVE",
  "isPreferred": true,
  "email": "payments@carrier.com",
  "phone": "+1-555-123-4567",
  "companyName": "Carrier Payments LLC",
  "username": "carrier_payments",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Carrier Transport Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "carrierFactor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-FACTOR-001",
    "companyName": "Capital Factoring Services Inc",
    "email": "accounting@capitalfactoring.com",
    "phoneNumber": "+1-555-234-5678",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "deletedBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  }
}

Update carrier payment method

Request

Partially update a carrier payment method. Only provided fields will be updated.

IMPORTANT: The carrierId field cannot be changed after creation.

Payment Recipient Type Constraints:

  • When changing to DIRECT: carrierFactorId must be set to null

  • When changing to FACTOR: carrierFactorId is required

  • Omitted fields: Not modified (current value preserved)

  • Provided fields: Updated to the new value

  • Null values: Clear the field (set to null) where applicable

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired
paymentRecipientTypestring(PaymentRecipientType)

Who receives the payment.

  • DIRECT: carrierFactorId must be null
  • FACTOR: carrierFactorId is required
Enum"DIRECT""FACTOR"
paymentMethodTypestring(PaymentMethodType)

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
statusstring or null

Payment method status

Example: "ACTIVE"
isPreferredboolean or null

Whether this is the preferred payment method

Example: true
emailstring or null(email)

Email address for payment notifications

Example: "payments@carrier.com"
phonestring or null

Phone number for payment contact

Example: "+1-555-123-4567"
companyNamestring or null

Company name for this payment method

Example: "Carrier Payments LLC"
usernamestring or null

Username for payment platforms

Example: "carrier_payments"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Carrier Transport Inc"
accountNumberstring or null

Bank account number

Example: "1234567890"
abaAchstring or null

ABA/ACH routing number

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number

Example: "001"
eftTransitstring or null

EFT transit number

Example: "00010"
clabestring or null

CLABE number

Example: "012180001234567897"
currencystring or null

Preferred currency code

Example: "USD"
carrierFactorIdstring or null(uuid)

Carrier factor ID.

Constraint: Required when paymentRecipientType is FACTOR, must be null when DIRECT.

Example: "550e8400-e29b-41d4-a716-446655440000"
paymentTermIdstring or null(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
curl -i -X PATCH \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-payment-methods/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bankName": "Bank of America",
    "accountNumber": "9876543210",
    "abaAch": "026009593"
  }'

Responses

Carrier payment method updated successfully

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier payment method identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
carrierIdstring(uuid)read-onlyrequired

Carrier profile ID (read-only after creation).

This field cannot be changed after the payment method is created.

Example: "770e8400-e29b-41d4-a716-446655440000"
carrierobject(CarrierReference)required

Carrier profile reference with full details

carrier.​idstring(uuid)required

Carrier UUID

Example: "550e8400-e29b-41d4-a716-446655440000"
carrier.​keystring or null<= 512 characters

Client-defined reference ID if set

Example: "ERP-CARRIER-SWIFT"
carrier.​namestringrequired

Carrier company name

Example: "Swift Transportation"
carrier.​phoneNumberstring or null

Primary phone number

Example: "+1-555-987-6543"
carrier.​emailstring or null(email)

Primary email address

Example: "dispatch@swifttrans.com"
carrier.​createdAtstring(date-time)required

When the carrier was created

Example: "2025-01-15T10:00:00Z"
carrier.​updatedAtstring(date-time)required

When the carrier was last updated

Example: "2025-01-15T14:30:00Z"
carrier.​deletedAtstring or null(date-time)

When the carrier was soft deleted (null if active)

Example: null
paymentRecipientTypestring(PaymentRecipientType)required

Who receives the payment.

  • DIRECT: Payment goes directly to the carrier (carrierFactorId must be null)
  • FACTOR: Payment goes to a factoring company (carrierFactorId is required)
Enum"DIRECT""FACTOR"
paymentMethodTypestring(PaymentMethodType)required

How payment is made

Enum"ACH_WIRE""ZELLE""VENMO""ACH""CHECK""WIRE""CAD_EFT""TRIUMPH_PAY""COMCHECK""EFS"
statusstring or null

Payment method status

Example: "ACTIVE"
isPreferredboolean or null

Whether this is the preferred payment method for the carrier

Example: true
emailstring or null(email)

Email address for payment notifications

Example: "payments@carrier.com"
phonestring or null

Phone number for payment contact

Example: "+1-555-123-4567"
companyNamestring or null

Company name for this payment method (may differ from carrier name)

Example: "Carrier Payments LLC"
usernamestring or null

Username for payment platforms (e.g., Zelle, Venmo)

Example: "carrier_payments"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Carrier Transport Inc"
accountNumberstring or null

Bank account number (masked in responses)

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
carrierFactorCarrierFactorReference (object) or null

Factoring company reference (required when paymentRecipientType is FACTOR).

When paymentRecipientType is DIRECT, this must be null.

Any of:

Enhanced reference to a carrier factor (factoring company). Includes full carrier factor details in addition to id/key.

paymentTermPaymentTermReference (object) or null

Payment terms for this payment method

Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

createdAtstring(date-time)read-onlyrequired

When the payment method was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the payment method was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the payment method was soft deleted (null if active)

Example: null
deletedByUserReference (object) or nullread-only

User who deleted this payment method

Any of:

Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.

Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.

Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carrierId": "770e8400-e29b-41d4-a716-446655440000",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "paymentRecipientType": "DIRECT",
  "paymentMethodType": "ACH",
  "status": "ACTIVE",
  "isPreferred": true,
  "email": "payments@carrier.com",
  "phone": "+1-555-123-4567",
  "companyName": "Carrier Payments LLC",
  "username": "carrier_payments",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Carrier Transport Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "carrierFactor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-FACTOR-001",
    "companyName": "Capital Factoring Services Inc",
    "email": "accounting@capitalfactoring.com",
    "phoneNumber": "+1-555-234-5678",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null,
  "deletedBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  }
}

Delete carrier payment method

Request

Soft delete a carrier payment method (sets deletedAt timestamp).

The payment method will no longer appear in default queries but can be retrieved by explicitly filtering for deleted records.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X DELETE \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-payment-methods/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier payment method deleted successfully

Response
No content

Companies

Company management operations

Operations

Credit Memos

AR credit memo management operations. Credit memos represent customer credits that can be applied to invoices.

Operations

Bills

AP bill management operations. Bills represent carrier and vendor invoices to be paid.

Operations

Bill Payments

AP bill payment management operations. Bill payments record payments made to carriers and vendors.

Operations

Customers

Customer management operations

Operations

Customer Contacts

Customer contact management operations

Operations

Documents

Document management operations. Documents are files (PDFs, images) that can be attached to orders, loads, or services.

Operations

Invoices

AR invoice management operations. Invoices represent customer billing for shipment services.

Operations

Loads

Load management operations. Loads represent carrier execution - which carrier is moving the freight.

Operations

Locations

Location management operations

Operations

Location Contacts

Location contact management operations

Operations

Payment Terms

Payment term management operations

Operations

Payments

AR payment management operations. Payments represent received customer payments applied to invoices.

Operations

Quotes

Quote management operations. Quotes are pricing requests/responses that can be converted to shipments.

Operations

Saved Searches

Saved search management operations

Operations

Services

Service (vended service) management operations. Services represent non-carrier vendor work (drayage, customs, warehousing).

Operations

Shipments

Shipment tracking and management operations. Shipments contain orders, loads, and services.

Operations

Teams

Team management operations

Operations

Users

User management operations

Operations

Vendors

Vendor management operations

Operations

Vendor Contacts

Vendor contact management operations

Operations

Vendor Payment Methods

Vendor payment method management operations

Operations

Event Notifications

Webhooks