Scout RFP (Workday Strategic Sourcing) Payment Types API
Use the payment types API to create, update, and query the payment types in Workday Strategic Sourcing. ## Payment Type Object ```
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/scoutrfp:scoutrfp-payment-types-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Workday Strategic Sourcing Payments Payment Types API
version: '1.0'
description: ''
servers:
- url: https://api.us.workdayspend.com/services/payments/v1
description: Production Server
- url: https://api.sandbox.us.workdayspend.com/services/payments/v1
description: Sandbox Server
security:
- api_key: []
user_token: []
user_email: []
tags:
- name: Payment Types
x-displayName: Payment Types
description: 'Use the payment types API to create, update, and query the payment types in Workday Strategic Sourcing.
## Payment Type Object
```'
paths:
/payment_types:
get:
tags:
- Payment Types
description: Returns a list of payment types.
operationId: ListPaymentTypes
summary: List Payment Types
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentType'
examples:
success:
$ref: '#/components/examples/index_response-2'
'401':
description: Unauthorized
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types\"\n"
x-operation-id-source: normalized
x-operation-id-original: List Payment Types
post:
tags:
- Payment Types
description: Create a payment type with given parameters.
operationId: CreateAPaymentType
summary: Create a Payment Type
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentTypeCreate'
examples:
success:
$ref: '#/components/examples/create_request-2'
responses:
'201':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentType'
examples:
success:
$ref: '#/components/examples/create_response-2'
'401':
description: Unauthorized
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n -X POST \\\n -d '{\"data\":{\"type\":\"payment_types\",\"attributes\":{\"name\":\"Payment Type\"}}' \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types\"\n"
x-operation-id-source: normalized
x-operation-id-original: Create a Payment Type
/payment_types/{id}:
patch:
tags:
- Payment Types
description: 'Updates the details of an existing payment type. You need to supply the unique
identifier that was returned upon payment type creation.
Please note, that request body must include an `id` attribute with the value of your payment type
unique identifier (the same one you passed in the URL).'
operationId: UpdateAPaymentType
summary: Update a Payment Type
parameters:
- name: id
in: path
description: Unique payment type identifier.
required: true
schema:
type: integer
example: 1
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentTypeUpdate'
examples:
success:
$ref: '#/components/examples/update_request-2'
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentType'
examples:
success:
$ref: '#/components/examples/update_response-2'
'401':
description: Unauthorized
'404':
description: Not Found
'409':
description: Conflict
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
examples:
invalid_type:
summary: Missing or invalid 'type' specified, expected 'payment_types'
description: 'Returns error due to invalid `type` parameter.
'
value:
errors:
- detail: Missing or invalid 'type' specified, expected 'payment_types'
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n -X PATCH \\\n -d '{\"data\":{\"type\":\"payment_types\",\"id\":\"2\",\"attributes\":{\"name\":\"Updated Field Payment Type\"}}}' \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types/2\"\n"
x-operation-id-source: normalized
x-operation-id-original: Update a Payment Type
delete:
tags:
- Payment Types
description: 'Deletes a payment type. You need to supply the unique payment type
identifier that was returned upon payment type creation.'
operationId: DeleteAPaymentType
summary: Delete a Payment Type
parameters:
- name: id
in: path
description: Unique payment type identifier.
required: true
schema:
type: integer
example: 1
responses:
'204':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n -X DELETE \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types/1\"\n"
x-operation-id-source: normalized
x-operation-id-original: Delete a Payment Type
/payment_types/{external_id}/external_id:
patch:
tags:
- Payment Types
description: 'Updates the details of an existing payment type. You need to supply the unique
external identifier assigned to the payment type on creation.
Please note, that request body must include an `id` attribute with the value of your payment type
unique identifier (the same one you passed in the URL).'
operationId: UpdateAPaymentTypeByExternalID
summary: Update a Payment Type by External ID
parameters:
- name: external_id
in: path
description: Unique payment type external identifier.
required: true
schema:
type: integer
example: PAYTYPE
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentTypeUpdate'
examples:
success:
$ref: '#/components/examples/external_update_request-2'
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PaymentType'
examples:
success:
$ref: '#/components/examples/external_update_response-2'
'401':
description: Unauthorized
'404':
description: Not Found
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n -X PATCH \\\n -d '{\"data\":{\"type\":\"payment_types\",\"id\":\"PAYTYPE\",\"attributes\":{\"name\":\"Updated Field Payment Type\"}}}' \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types/PAYTYPE/external_id\"\n"
x-operation-id-source: normalized
x-operation-id-original: Update a Payment Type by External ID
delete:
tags:
- Payment Types
description: 'Deletes a payment type. You need to supply the unique payment type
external identifier assigned to the payment type on creation.'
operationId: DeleteAPaymentTypeByExternalID
summary: Delete a Payment Type by External ID
parameters:
- name: external_id
in: path
description: Unique payment type external identifier.
required: true
schema:
type: integer
example: PAYTYPE
responses:
'204':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
x-codeSamples:
- label: Curl
source: "curl -H \"X-Api-Key: ${COMPANY_KEY}\" \\\n -H \"X-User-Token: ${USER_TOKEN}\" \\\n -H \"X-User-Email: ${USER_EMAIL}\" \\\n -H \"Content-Type: application/vnd.api+json\" \\\n -X DELETE \\\n \"https://api.us.workdayspend.com/services/payments/v1/payment_types/PAYTYPE/external_id\"\n"
x-operation-id-source: normalized
x-operation-id-original: Delete a Payment Type by External ID
components:
examples:
create_response-2:
value:
data:
id: '1'
type: payment_types
attributes:
name: 'Payment Type #1'
external_id: PAYTYPE-1
payment_method: Cash
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types/1
update_request-2:
value:
data:
type: payment_types
id: '1'
attributes:
name: Payment Type Updated
external_id: PAYTYPE-UPD
payment_method: Cash
index_response-2:
value:
data:
- id: '1'
type: payment_types
attributes:
name: 'Payment Type #1'
external_id: PAYTYPE-1
payment_method: Cash
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types/1
- id: '2'
type: payment_types
attributes:
name: 'Payment Type #2'
external_id: PAYTYPE-2
payment_method: Check
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types/2
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types
external_update_request-2:
value:
data:
type: payment_types
id: PAYTYPE
attributes:
name: Payment Type Updated
payment_method: Cash
create_request-2:
value:
data:
type: payment_types
attributes:
name: 'Payment Type #1'
external_id: PAYTYPE-1
payment_method: Cash
external_update_response-2:
value:
data:
id: '1'
type: payment_types
attributes:
name: Payment Type Updated
external_id: PAYTYPE
payment_method: Cash
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types/1
update_response-2:
value:
data:
id: '1'
type: payment_types
attributes:
name: Payment Type Updated
external_id: PAYTYPE-UPD
payment_method: Cash
links:
self: https://api.us.workdayspend.com/services/payments/v1/payment_types/1
schemas:
PaymentTypeType:
type: string
description: Object type, should always be `payment_types`.
example: payment_types
PaymentType:
allOf:
- $ref: '#/components/schemas/PaymentTypeBase'
- type: object
properties:
attributes:
$ref: '#/components/schemas/PaymentTypeAttributes'
PaymentTypeCreate:
type: object
required:
- type
properties:
type:
$ref: '#/components/schemas/PaymentTypeType'
attributes:
allOf:
- $ref: '#/components/schemas/PaymentTypeAttributes'
- type: object
required:
- payment_method
Error:
type: object
properties:
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
PaymentTypeBase:
title: Field
type: object
required:
- type
- id
properties:
type:
$ref: '#/components/schemas/PaymentTypeType'
id:
$ref: '#/components/schemas/PaymentTypeId'
PaymentTypeAttributes:
type: object
description: Payment type attributes.
required:
- name
properties:
name:
type: string
maxLength: 255
description: Payment type name.
external_id:
type: string
maxLength: 255
description: Payment type external identifier.
payment_method:
type: string
description: Payment method.
enum:
- Direct Deposit
- Check
- EFT
- Cash
- Credit Card
- Wire
- Manual
- Direct Debit
- PayPal
- EFT with Reference
example: Cash
PaymentTypeUpdate:
type: object
required:
- type
- id
properties:
type:
$ref: '#/components/schemas/PaymentTypeType'
id:
$ref: '#/components/schemas/PaymentTypeId'
attributes:
$ref: '#/components/schemas/PaymentTypeAttributes'
PaymentTypeId:
type: integer
description: Payment type identifier string.
example: 1
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
securitySchemes:
api_key:
type: apiKey
name: X-Api-Key
in: header
description: Company API key.
user_token:
type: apiKey
name: X-User-Token
in: header
description: User token.
user_email:
type: apiKey
name: X-User-Email
in: header
description: User email.
x-tagGroups:
- name: Getting Started
tags:
- support
- servers
- api_specification
- date_and_time_fields
- authentication
- rate_limiting
- external_ids
- filters
- name: Payments
tags:
- payment_currencies
- payment_types
- payment_terms