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.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

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 query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services
User typeBusiness user with admin permissions
PermissionsList, View, Subscribe, Configure Application Subscriptions
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.



Permissions and other requirements



SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services


User typeBusiness user with admin permissions


PermissionsList, View, Subscribe, Configure Application Subscriptions







SecurityOAuth2 
Request 
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 
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.



Permissions and other requirements



SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services


User typeBusiness user with admin permissions


PermissionsList, View, Subscribe, Configure Application Subscriptions







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


 
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.



Permissions and other requirements



SubscriptionAdministration, Sage Cloud Services, Outbound Payment Services


User typeBusiness user with admin permissions


PermissionsList, View, Subscribe, Configure Application Subscriptions







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


 
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
    }
}
Query payment provider bank accounts
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "cash-management/payment-provider-bank-account"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/payment-provider-bank-account",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "key",
    • "paymentProvider.id",
    • "bankAccount.id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "19",
      • "id": "19",
      • "paymentProvider.id": "CSI",
      • "bankAccount.id": "BOA",
      • "href": "/objects/cash-management/payment-provider-bank-account/19"
      },
    • {
      • "key": "22",
      • "id": "22",
      • "paymentProvider.id": "CSI",
      • "bankAccount.id": "WF",
      • "href": "/objects/cash-management/payment-provider-bank-account/22"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}