Provider payment methods

Provides relevant information for a subscribed payment provider's supported payment methods. After confirming a payment provider's information, you can associate a vendor and a bank account with that payment provider. See Payment provider bank accounts and Vendor payment providers to learn more. Payment provider services, like Vendor Payments powered by CSI, are only for US vendors accepting USD. See Compare payment methods for more information.

List provider payment methods

get/objects/cash-management/provider-payment-method

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

Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services
User typeBusiness user with admin permissions
PermissionsList, View Application Subscriptions
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "453",
      • "id": "453",
      • "href": "/objects/cash-management/provider-payment-method/453"
      },
    • {
      • "key": "454",
      • "id": "454",
      • "href": "/objects/cash-management/provider-payment-method/454"
      },
    • {
      • "key": "455",
      • "id": "455",
      • "href": "/objects/cash-management/provider-payment-method/455"
      },
    • {
      • "key": "456",
      • "id": "456",
      • "href": "/objects/cash-management/provider-payment-method/456"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Get a provider payment method
get/objects/cash-management/provider-payment-method/{key}
Returns detailed information for a specified provider payment method.



Permissions and other requirements



SubscriptionCash Management, Sage Cloud Services, Outbound Payment Services


User typeBusiness user with admin permissions


PermissionsList, View Application Subscriptions







SecurityOAuth2 
Request 
path Parameters
key
required
string
Payment method key


 
 Example:  454
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "454",
    • "id": "454",
    • "paymentProvider": {
      • "id": "CSI",
      • "name": "CSI",
      • "key": "3",
      • "href": "/objects/cash-management/payment-provider/3"
      },
    • "paymentType": "CHECK",
    • "audit": {
      • "createdDateTime": "2021-07-30T03:29:20Z",
      • "modifiedDateTime": "2021-09-06T05:17:26Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "href": "/objects/cash-management/provider-payment-method/454"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query provider payment methods
post/services/core/query
Use the query service to find provider payment methods that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples