Stored Payment Methods

Stored Payment Methods

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

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.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

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

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this stored payment method

contact_id
required
string (Contact)

The name of the customer whose payment method is being stored

name
required
string (Name)

The name of the stored payment method

type
required
string (Type)

Type of stored payment

Enum: "credit card" "electronic check"
credit_card_type
required
string (Credit Card Type)

Credit card type

Enum: "visa" "mastercard" "american express" "discover" "other"
required
Array of objects non-empty
name_on_account
required
string (Name On Account)

The name on the account

last_four_digits
required
string (Last Four Digits) 4 characters

Last four digits of the account number

object (Address)

A complete address

expires
string <date> (Expires)

Date of expiration

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The stored payment method was saved successfully.
400The stored payment method you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The stored payment method could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add stored payment method based on tenant limits.
500General server error.
post/storedPaymentMethods/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the stored payment method to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The stored payment method was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
429Limit exceeded... unable to retrieve stored payment method based on tenant limits.
500General server error.
get/storedPaymentMethods/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Updates a stored payment method with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the stored payment method to update.

Request Body schema: application/json

The updated stored payment method that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this stored payment method

contact_id
required
string (Contact)

The name of the customer whose payment method is being stored

name
required
string (Name)

The name of the stored payment method

type
required
string (Type)

Type of stored payment

Enum: "credit card" "electronic check"
credit_card_type
required
string (Credit Card Type)

Credit card type

Enum: "visa" "mastercard" "american express" "discover" "other"
required
Array of objects non-empty
name_on_account
required
string (Name On Account)

The name on the account

last_four_digits
required
string (Last Four Digits) 4 characters

Last four digits of the account number

object (Address)

A complete address

expires
string <date> (Expires)

Date of expiration

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The stored payment method was updated successfully.
400The stored payment method supplied was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
409The stored payment method could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve stored payment method based on tenant limits.
500General server error.
put/storedPaymentMethods/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Partially updates a stored payment method with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the stored payment method to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The stored payment method was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
409The stored payment method could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve stored payment method based on tenant limits.
500General server error.
patch/storedPaymentMethods/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the stored payment method to delete.

Responses
200The stored payment method was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
409The stored payment method could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete stored payment method based on tenant limits.
500General server error.
delete/storedPaymentMethods/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

query Parameters
fields
string

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

Responses
200The stored payment methodswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/portal/contact/:portalContactId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

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

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.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

Request Body schema: application/json

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

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this stored payment method

contact_id
required
string (Contact)

The name of the customer whose payment method is being stored

name
required
string (Name)

The name of the stored payment method

type
required
string (Type)

Type of stored payment

Enum: "credit card" "electronic check"
credit_card_type
required
string (Credit Card Type)

Credit card type

Enum: "visa" "mastercard" "american express" "discover" "other"
required
Array of objects non-empty
name_on_account
required
string (Name On Account)

The name on the account

last_four_digits
required
string (Last Four Digits) 4 characters

Last four digits of the account number

object (Address)

A complete address

expires
string <date> (Expires)

Date of expiration

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The stored payment method was saved successfully.
400The stored payment method you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The stored payment method could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add stored payment method based on tenant limits.
500General server error.
post/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}
Request samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

id
required
string

The ID of the stored payment method to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The stored payment method was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
429Limit exceeded... unable to retrieve stored payment method based on tenant limits.
500General server error.
get/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/portal/contact/:portalContactId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Updates a stored payment method with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

id
required
string

The ID of the stored payment method to update.

Request Body schema: application/json

The updated stored payment method that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this stored payment method

contact_id
required
string (Contact)

The name of the customer whose payment method is being stored

name
required
string (Name)

The name of the stored payment method

type
required
string (Type)

Type of stored payment

Enum: "credit card" "electronic check"
credit_card_type
required
string (Credit Card Type)

Credit card type

Enum: "visa" "mastercard" "american express" "discover" "other"
required
Array of objects non-empty
name_on_account
required
string (Name On Account)

The name on the account

last_four_digits
required
string (Last Four Digits) 4 characters

Last four digits of the account number

object (Address)

A complete address

expires
string <date> (Expires)

Date of expiration

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Responses
200The stored payment method was updated successfully.
400The stored payment method supplied was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
409The stored payment method could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve stored payment method based on tenant limits.
500General server error.
put/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "contact_id": "string",
  • "name": "string",
  • "type": "credit card",
  • "credit_card_type": "visa",
  • "merchant_account_tokens": [
    ],
  • "name_on_account": "string",
  • "last_four_digits": "stri",
  • "billing_address": {
    },
  • "expires": "2019-08-24",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

id
required
string

The ID of the stored payment method to delete.

Responses
200The stored payment method was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The stored payment method could not be found.
409The stored payment method could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete stored payment method based on tenant limits.
500General server error.
delete/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/portal/contact/:portalContactId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of records with the specified contact_id

Returns a list of records with the specified contact_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

contact_id
required
string

The contact_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/storedPaymentMethods/{tenantId}/contact/{contact_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/storedPaymentMethods/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}