Payment providers

Provides information about subscribed payment providers. For example, if an account includes a subscription to Vendor Payments powered by CSI, you can use these operations to retrieve information for that payment provider. 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 providers

get/objects/cash-management/payment-provider

Returns up to 100 object references from the collection with a key, ID, and link for each payment provider. 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

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "3",
      • "id": "CSI",
      • "href": "/objects/cash-management/payment-provider/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Get a payment provider
get/objects/cash-management/payment-provider/{key}
Returns detailed information for a specified payment provider, including name, ID, payment withdrawal type, and payment methods.


SecurityOAuth2 
Request 
path Parameters
key
required
string
Payment provider key


 
 Example:  3
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "CSI",
    • "name": "CSI",
    • "contactInfo": {},
    • "paymentWithdrawalType": "perTransaction",
    • "state": "subscribed",
    • "audit": {
      • "createdDateTime": "2021-07-28T11:07:33Z",
      • "modifiedDateTime": "2021-09-06T05:17:26Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "paymentMethods": [
      • {
        }
      ],
    • "href": "/objects/cash-management/payment-provider/3"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}