Payment provider bank accounts

Models the bank accounts associated with a payment provider for electronic payments. After the subscription status for a payment provider is Subscribed, you can add bank accounts for that payment provider. Subscribed status is set after your company's application has been received by the payment provider and all required paperwork has been signed. Payment provider services, like Vendor Payments powered by CSI, are only for US vendors accepting USD. See Compare payment methods for more information.

List payment provider bank accounts

get/objects/cash-management/payment-provider-bank-account

Returns up to 100 object references from the collection with a key, ID, and link for each payment provider bank account. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

404

Not Found

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/cash-management/payment-provider-bank-account/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/cash-management/payment-provider-bank-account/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/cash-management/payment-provider-bank-account/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Create a payment provider bank account
post/objects/cash-management/payment-provider-bank-account
Creates a new payment provider bank account.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
checkStartNumber
string
Starting check number specific to the payment provider.


 
 Example:  "111999"
isRebateAccount
boolean
 Default:  false
Indicates whether this is the account in which virtual card payment rebates are deposited.


 
 Example:  true
remittanceEmail
string
Email address to receive the bank remittance.


 
 Example:  "[email protected]"
object
 
key
string
System-assigned key for the bank account.


 
 Example:  "72"
id
string
Unique identifier for the bank account.


 
 Example:  "BOA"
object
 
key
string
System-assigned key for the payment provider.


 
 Example:  "1"
id
string
Unique identifier for the payment provider.


 
 Example:  "CSI"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


422
Unprocessable entity


Request samples 
application/json
{
  • "paymentProvider": {
    • "id": "CSI"
    },
  • "bankAccount": {
    • "id": "WF"
    },
  • "status": "active",
  • "checkStartNumber": "111000",
  • "remittanceEmail": "[email protected]"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "22",
    • "id": "22",
    • "href": "/objects/cash-management/payment-provider-bank-account/22"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a payment provider bank account
get/objects/cash-management/payment-provider-bank-account/{key}
Returns detailed information for a specified payment provider bank account.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the payment provider bank account.


 
 Example:  99
Responses 
200
OK


404
Not Found


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "19",
    • "id": "19",
    • "paymentProvider": {
      • "key": "1",
      • "id": "CSI",
      • "href": "/objects/cash-management/payment-provider/1"
      },
    • "bankAccount": {
      • "key": "72",
      • "id": "BOA",
      • "currency": "USD",
      • "href": "/objects/cash-management/checking-account/72"
      },
    • "state": "subscribed",
    • "isRebateAccount": false,
    • "providerReferenceNumber": "44397977-72-1643357336",
    • "authenticationURL": "",
    • "audit": {
      • "createdDateTime": "2022-01-28T08:08:56Z",
      • "modifiedDateTime": "2022-01-28T08:23:08Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "checkStartNumber": "123456",
    • "href": "/objects/cash-management/payment-provider-bank-account/19"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a payment provider bank account
patch/objects/cash-management/payment-provider-bank-account/{key}
Updates an existing payment provider bank account by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the payment provider bank account.


 
 Example:  99
Request Body schema: application/json
checkStartNumber
string
Starting check number specific to the payment provider.


 
 Example:  "111999"
isRebateAccount
boolean
 Default:  false
Indicates whether this is the account in which virtual card payment rebates are deposited.


 
 Example:  true
remittanceEmail
string
Email address to receive the bank remittance.


 
 Example:  "[email protected]"
object
 
key
string
System-assigned key for the bank account.


 
 Example:  "72"
id
string
Unique identifier for the bank account.


 
 Example:  "BOA"
object
 
key
string
System-assigned key for the payment provider.


 
 Example:  "1"
id
string
Unique identifier for the payment provider.


 
 Example:  "CSI"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "isRebateAccount": false,
  • "checkStartNumber": "111222"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "19",
    • "id": "19",
    • "href": "/objects/cash-management/payment-provider-bank-account/19"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}