Payments

Payments

Processes a payment

This method will auto-generate an ID and create a new payment. If an ID is specified for the payment, 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 payment that you would like to be saved.

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

The unique, string identifier of this payment

payment_that_this_transaction_reverses_id
string (Payment That This Transaction Reverses)

The name of the payment that THIS payment reverses or backs out

owner_type
required
string (Owner Type)

The type of owner

Enum: "contact" "organization"
contact_id
required
string (Contact)

The contact that owns the payment

reference_number
string (Reference Number)

A reference number to be used for the payment

organization_id
required
string (Organization)

The organization that owns the payment

type
required
string (Type)

The type of payment

Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "store credit" "offline credit card"
status
string (Status)
Enum: "complete" "void" "reversed" "refunded" "partially refunded"
amount_pending_capture
number <double> (Amount Pending Capture)

The amount of payment yet to be captured

cash_account_type
required
string (Cash Account Type)

Type of cash account to use

Enum: "bank" "merchant" "none"
bank_account_id
required
string (Bank Account)

The bank account to use for this payment

merchant_account_id
required
string (Merchant Account)

The merchant account to use for this payment

send_email_confirmation
boolean (Send Email Confirmation)

Whether to send an email confirmation

send_receipt_to
string (Send Receipt To)

The email address(es) to send receipts

object (Address)

A complete address

transaction_id
string (Transaction)

The transaction id of the capture

card_type
string (Card Type)

The card type

card_expiration
string <date> (Card Expiration)

The card expiration

card_last_digits
string (Card Last Digits)

The last 4 digits of the card that was processed

Array of objects
required
object (Electronic Payment Info)
required
Array of objects non-empty
sys_search_transaction_id
string (Sys Search Transaction)

Internal use

sys_search_credit_card_type
string (Sys Search Credit Card Type)

Internal use

Array of objects (Custom Field Values)
number
required
integer (Number)

The transaction number

workflow_execution_id
string (Workflow Execution)

The ID of the state machine execution used to create this transaction

total
required
number <double> (Total)

The transaction total

business_unit_id
required
string (Business Unit)

The business unit this transaction belongs to

batch_id
required
string (Batch)

The batch this transaction belongs to

cancellation_id
string (Cancellation)

The order cancellation tied to this transaction

order_id
string (Order)

The order tied to this transaction

return_id
string (Return)

The return tied to this transaction

memo
string (Memo)

Memo/description of the transaction

notes
string (Notes)

Notes fro the transaction

date
string <date> (Date)

The date of the transaction

currency_code
string (Currency Code) 3 characters

The currency code in use

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EEK" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GQE" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZM" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEB" "VND" "VUV" "WST" "XAF" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZWR"
currency_symbol
string (Currency Symbol)

The currency symbol

exchange_rate
number <double> (Exchange Rate)

The exchange rate, if applicable

total_in_base_currency
required
number <double> (Total In Base Currency)

The transaction total in base currency

base_currency_code
string (Base Currency Code) 3 characters

The base currency for transactions business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the transactions business unit

sys_search_composite_key
string (Sys Search Composite Key)

Internal use

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 payment process was started
400The payment you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add payment based on tenant limits.
500General server error.
post/payments/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Returns a payment from the system by its ID.

This method will look up a payment 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 payment 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 payment was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error.
get/payments/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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 payment with the specified ID.

This method will update an existing payment 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 payment to update.

Request Body schema: application/json

The updated payment that will be saved.

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

The unique, string identifier of this payment

payment_that_this_transaction_reverses_id
string (Payment That This Transaction Reverses)

The name of the payment that THIS payment reverses or backs out

owner_type
required
string (Owner Type)

The type of owner

Enum: "contact" "organization"
contact_id
required
string (Contact)

The contact that owns the payment

reference_number
string (Reference Number)

A reference number to be used for the payment

organization_id
required
string (Organization)

The organization that owns the payment

type
required
string (Type)

The type of payment

Enum: "credit card" "electronic check" "cash" "check" "cashiers check" "money order" "purchase order" "payroll deduction" "wire transfer" "ach" "store credit" "offline credit card"
status
string (Status)
Enum: "complete" "void" "reversed" "refunded" "partially refunded"
amount_pending_capture
number <double> (Amount Pending Capture)

The amount of payment yet to be captured

cash_account_type
required
string (Cash Account Type)

Type of cash account to use

Enum: "bank" "merchant" "none"
bank_account_id
required
string (Bank Account)

The bank account to use for this payment

merchant_account_id
required
string (Merchant Account)

The merchant account to use for this payment

send_email_confirmation
boolean (Send Email Confirmation)

Whether to send an email confirmation

send_receipt_to
string (Send Receipt To)

The email address(es) to send receipts

object (Address)

A complete address

transaction_id
string (Transaction)

The transaction id of the capture

card_type
string (Card Type)

The card type

card_expiration
string <date> (Card Expiration)

The card expiration

card_last_digits
string (Card Last Digits)

The last 4 digits of the card that was processed

Array of objects
required
object (Electronic Payment Info)
required
Array of objects non-empty
sys_search_transaction_id
string (Sys Search Transaction)

Internal use

sys_search_credit_card_type
string (Sys Search Credit Card Type)

Internal use

Array of objects (Custom Field Values)
number
required
integer (Number)

The transaction number

workflow_execution_id
string (Workflow Execution)

The ID of the state machine execution used to create this transaction

total
required
number <double> (Total)

The transaction total

business_unit_id
required
string (Business Unit)

The business unit this transaction belongs to

batch_id
required
string (Batch)

The batch this transaction belongs to

cancellation_id
string (Cancellation)

The order cancellation tied to this transaction

order_id
string (Order)

The order tied to this transaction

return_id
string (Return)

The return tied to this transaction

memo
string (Memo)

Memo/description of the transaction

notes
string (Notes)

Notes fro the transaction

date
string <date> (Date)

The date of the transaction

currency_code
string (Currency Code) 3 characters

The currency code in use

Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EEK" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GQE" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZM" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEB" "VND" "VUV" "WST" "XAF" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZWR"
currency_symbol
string (Currency Symbol)

The currency symbol

exchange_rate
number <double> (Exchange Rate)

The exchange rate, if applicable

total_in_base_currency
required
number <double> (Total In Base Currency)

The transaction total in base currency

base_currency_code
string (Base Currency Code) 3 characters

The base currency for transactions business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the transactions business unit

sys_search_composite_key
string (Sys Search Composite Key)

Internal use

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 payment was updated successfully.
400The payment supplied was not valid.
401Unauthorized.
403Forbidden.
404The payment could not be found.
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error.
put/payments/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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 payment with the specified ID.

This method will patch an existing payment 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 payment 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 payment was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The payment could not be found.
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error.
patch/payments/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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 payment from the system by its ID.

This method will delete a payment 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 payment to delete.

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

Gets all of the payments in the system for a given contact.

This method will scan all payments 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 paymentswere 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/payments/{tenantId}/portal/contact/{portalContactId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/portal/contact/:portalContactId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

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

This method will look up a payment 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 payment 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 payment was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error.
get/payments/{tenantId}/portal/contact/{portalContactId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/portal/contact/:portalContactId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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": { }
}

Gets all of the payments in the system for a given organization.

This method will scan all payments and and return them to the caller for a given organization.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalOrganizationId
required
string

The organization to use

query Parameters
fields
string

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

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

Returns a payment from the system by its ID for a given organization.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalOrganizationId
required
string

The organization to use

id
required
string

The ID of the payment 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 payment was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error.
get/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/portal/organization/:portalOrganizationId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "payment_that_this_transaction_reverses_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "reference_number": "string",
  • "organization_id": "string",
  • "type": "credit card",
  • "status": "complete",
  • "amount_pending_capture": 0,
  • "cash_account_type": "bank",
  • "bank_account_id": "string",
  • "merchant_account_id": "string",
  • "send_email_confirmation": true,
  • "send_receipt_to": "string",
  • "billing_address": {
    },
  • "transaction_id": "string",
  • "card_type": "string",
  • "card_expiration": "2019-08-24",
  • "card_last_digits": "string",
  • "captures": [
    ],
  • "electronic_payment_info": {
    },
  • "line_items": [
    ],
  • "sys_search_transaction_id": "string",
  • "sys_search_credit_card_type": "string",
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "string",
  • "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": { }
}

Initiates a payment reversal

This method will start a reversal payment process

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the payment to update

batch_id
required
string

The ID of the batch that the reversal should be placed

Request Body schema: application/json

The memo that explains the reversal

string
Responses
200The payment reversal was started successfully
400The payment record you supplied was invalid.
401Unauthorized
403Forbidden
404The payment could not be found.
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to update payment based on tenant limits.
500General server error
put/payments/{tenantId}/{id}/reverse/{batch_id}
Request samples
application/json
"string"
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Returns a list of records with the specified owner

Returns a list of records with the specified owner

Request
Security:
path Parameters
tenantId
required
string

The tenant

ownerType
required
string

The type of owner

Enum: "contact" "organization"
ownerId
required
string

The ID of the owner

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

includeAllPayments
boolean

If set, all payments are returned regardless of balance

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/payments/{tenantId}/owner/{ownerType}/{ownerId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/owner/:ownerType/:ownerId?fields=string&exclusiveStartKey=string&includeAllPayments=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Generates a PDF and returns the public link for download

Generates a PDF and returns the public link for download

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the payment to return

Responses
200The payment was downloaded successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/payments/{tenantId}/renderEmail/{id}
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/payments/:tenantId/renderEmail/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Emails an HTML version of the payment

Send an email of the payment

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the payment to return

query Parameters
additionalRecipients
string

Others who should receive the email

Responses
200The payment was emailed successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
post/payments/{tenantId}/email/{id}
Request samples
curl -i -X POST \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/email/:id?additionalRecipients=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

invoice_id
string (Invoice)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
payment_id
required
string (Payment)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/payments/{tenantId}/previewEmail
Request samples
application/json
{
  • "invoice_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string",
  • "payment_id": "string"
}

Returns the default payment template

Returns the default payment template

Request
Security:
Responses
200The payment template
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
get/payments/defaultTemplateAndEmail/payment
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/payments/defaultTemplateAndEmail/payment \
  -H 'Authorization: YOUR_API_KEY_HERE'

Returns the default payment template

Returns the default payment template

Request
Security:
Responses
200The payment template
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/payments/defaultTemplate/paymentReceipt
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/payments/defaultTemplate/paymentReceipt \
  -H 'Authorization: YOUR_API_KEY_HERE'

Initiates a payment void

This method will start a void payment process

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the payment to update

Responses
200The payment void was started successfully
400The payment record you supplied was invalid.
401Unauthorized
403Forbidden
404The payment could not be found.
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to update payment based on tenant limits.
500General server error
put/payments/{tenantId}/{id}/void
Request samples
curl -i -X PUT \
  https://collect.api.rhythmsoftware.com/payments/:tenantId/:id/void \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Generates a PDF and returns the public link for download

Generates a PDF and returns the public link for download

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the payment to return

query Parameters
downloadAsHtml
boolean

If true, return the receipt as HTML

Responses
200The payment was downloaded successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/payments/{tenantId}/print/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/print/:id?downloadAsHtml=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Searches for payments using predefined parameters

Searches for payments using predefined parameters

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The payment that you would like to be saved.

business_unit_id
required
string (Business Unit)

The business unit

batch_id
Array of strings (Batch)
date
Array of strings (Date) 2 items
number
Array of numbers <float> (Number) 2 items
total
Array of numbers <float> (Total) 2 items
id
Array of strings (ID)
total_in_base_currency
Array of numbers <float> (Total In Base Currency) 2 items
status
Array of strings <date-time> (Status) 2 items
type
Array of strings <date-time> (Type) 2 items
owner_type
string (Owner Type)
contact_id
string (Contact)
organization_id
string (Organization)
merchant_account_id
Array of strings (Merchant Account) 2 items
bank_account_id
Array of strings (Bank Account) 2 items
credit_card_type
Array of strings (Credit Card Type) 2 items
transaction_id
Array of strings (Transaction) 2 items
reference_number
string (Reference Number)
Responses
200The payment search was saved successfully.
400The payment you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The payment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add payment based on tenant limits.
500General server error.
post/payments/{tenantId}/search
Request samples
application/json
{
  • "business_unit_id": "string",
  • "batch_id": [
    ],
  • "date": [
    ],
  • "number": [
    ],
  • "total": [
    ],
  • "id": [
    ],
  • "total_in_base_currency": [
    ],
  • "status": [
    ],
  • "type": [
    ],
  • "owner_type": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "merchant_account_id": [
    ],
  • "bank_account_id": [
    ],
  • "credit_card_type": [
    ],
  • "transaction_id": [
    ],
  • "reference_number": "string"
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified batch_id

Returns a list of records with the specified batch_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

batch_id
required
string

The batch_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/payments/{tenantId}/batch/{batch_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/batch/:batch_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "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/payments/{tenantId}/contact/{contact_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified organization_id

Returns a list of records with the specified organization_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

organization_id
required
string

The organization_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/payments/{tenantId}/organization/{organization_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/payments/:tenantId/organization/:organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Sends out a preview of the notification template

Sends out a preview of the notification template

Request
Security:
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

invoice_id
string (Invoice)
template
required
string (Template)
id
required
string (ID)

The refund id

Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/payments/{tenantId}/previewTemplate
Request samples