Collect

Collect (Finance & Billing) (v1-2025-04-18)

The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of Invoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods and can be used to download batches for import into your accounting package.

Like most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

collect-v1.json

collect-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/

https://collect.api.rhythmsoftware.com/

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Creates a new stored payment method record that does not already exist.

Request

This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The stored payment method that you would like to be saved.

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "contact_id": "string",
    "credit_card_type": "american express",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "expires": "2019-08-24",
    "id": "string",
    "last_four_digits": "stri",
    "merchant_account_tokens": [
      {
        "merchant_account_id": "string",
        "token": "string"
      }
    ],
    "name": "string",
    "name_on_account": "string",
    "payrix_migrated": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "credit card"
  }'

Responses

The stored payment method was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified contact_id

Request

Returns a list of records with the specified contact_id

Path

tenantIdstringrequired

The tenant

contact_idstringrequired

The contact_id to use to for record lookup

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/contact/{contact_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(StoredPaymentMethod)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Gets all of the stored payment methods in the system for a given contact.

Request

This method will scan all stored payment methods and and return them to the caller for a given contact.

Path

tenantIdstringrequired

The id of the tenant being accessed.

portalContactIdstringrequired

The contact to use

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}?fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The stored payment methodswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(StoredPaymentMethod)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Creates a new stored payment method record that does not already exist.

Request

This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

portalContactIdstringrequired

The contact to use

Bodyapplication/jsonrequired

The stored payment method that you would like to be saved.

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "contact_id": "string",
    "credit_card_type": "american express",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "expires": "2019-08-24",
    "id": "string",
    "last_four_digits": "stri",
    "merchant_account_tokens": [
      {
        "merchant_account_id": "string",
        "token": "string"
      }
    ],
    "name": "string",
    "name_on_account": "string",
    "payrix_migrated": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "credit card"
  }'

Responses

The stored payment method was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Returns a stored payment method from the system by its ID.

Request

This method will delete a stored payment method with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

portalContactIdstringrequired

The contact to use

idstringrequired

The ID of the stored payment method to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The stored payment method was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a stored payment method from the system by its ID for a given contact.

Request

This method will look up a stored payment method by the specified ID and return it back (for a portal contact)

Path

tenantIdstringrequired

The id of the tenant being accessed.

portalContactIdstringrequired

The contact to use

idstringrequired

The ID of the stored payment method to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The stored payment method was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Updates a stored payment method with the specified ID.

Request

This method will update an existing stored payment method with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

portalContactIdstringrequired

The contact to use

idstringrequired

The ID of the stored payment method to update.

Bodyapplication/jsonrequired

The updated stored payment method that will be saved.

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "contact_id": "string",
    "credit_card_type": "american express",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "expires": "2019-08-24",
    "id": "string",
    "last_four_digits": "stri",
    "merchant_account_tokens": [
      {
        "merchant_account_id": "string",
        "token": "string"
      }
    ],
    "name": "string",
    "name_on_account": "string",
    "payrix_migrated": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "credit card"
  }'

Responses

The stored payment method was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Returns a stored payment method from the system by its ID.

Request

This method will delete a stored payment method with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the stored payment method to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The stored payment method was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a stored payment method from the system by its ID.

Request

This method will look up a stored payment method by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the stored payment method to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The stored payment method was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Partially updates a stored payment method with the specified ID.

Request

This method will patch an existing stored payment method with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the stored payment method to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The stored payment method was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Updates a stored payment method with the specified ID.

Request

This method will update an existing stored payment method with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the stored payment method to update.

Bodyapplication/jsonrequired

The updated stored payment method that will be saved.

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/storedPaymentMethods/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "contact_id": "string",
    "credit_card_type": "american express",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "expires": "2019-08-24",
    "id": "string",
    "last_four_digits": "stri",
    "merchant_account_tokens": [
      {
        "merchant_account_id": "string",
        "token": "string"
      }
    ],
    "name": "string",
    "name_on_account": "string",
    "payrix_migrated": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "credit card"
  }'

Responses

The stored payment method was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_addressobject(Address)

A complete address

contact_idstring(Contact)required

The name of the customer whose payment method is being stored

credit_card_typestring(Credit Card Type)required

Credit card type

Enum"american express""discover""mastercard""other""visa"

custom_field_valuesArray of objects(Custom Field Values)

expiresstring(date)(Expires)

Date of expiration

idstring(ID)^[\w|-]+$required

The unique, string identifier of this stored payment method

last_four_digitsstring(Last Four Digits)= 4 charactersrequired

Last four digits of the account number

merchant_account_tokensArray of objectsnon-emptyrequired

merchant_account_tokens[].merchant_account_idstring(Merchant Account)required

The merchant account being vaulted

merchant_account_tokens[].tokenstring(Token)required

The token for this payment method for the merchant account

namestring(Name)required

The name of the stored payment method

name_on_accountstring(Name On Account)required

The name on the account

payrix_migratedboolean(Payrix Migrated)

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Type of stored payment

Enum"credit card""electronic check"

Response

application/json

{
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "contact_id": "string",
  "credit_card_type": "american express",
  "custom_field_values": [
    { … }
  ],
  "expires": "2019-08-24",
  "id": "string",
  "last_four_digits": "stri",
  "merchant_account_tokens": [
    { … }
  ],
  "name": "string",
  "name_on_account": "string",
  "payrix_migrated": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "credit card"
}

Subledger Entries

Operations

Write Offs

Operations

Collect (Finance & Billing) (v1-2025-04-18)

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Settings

Statement Templates

Statements

Statistics

Stored Payment Methods

Creates a new stored payment method record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified contact_id

Request

Responses

Was this helpful?

Gets all of the stored payment methods in the system for a given contact.

Request

Responses

Was this helpful?

Creates a new stored payment method record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a stored payment method from the system by its ID.

Request

Responses

Was this helpful?

Returns a stored payment method from the system by its ID for a given contact.

Request

Request

Request

Request

Request