- Created by George Rossides, last modified by Former user on Aug 23, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment gateway request |
number | String | The number of the retrieved payment gateway request |
life_cycle_state | String | The life cycle state of the retrieved payment gateway request which can be PENDING, POSTED or REJECTED |
| reference_number | String | The payment gateway request reference number as provided by the payment gateway |
| execution_date | Date | The execution date of the retrieved payment gateway request |
| error_code | String | The error code received by the payment gateway provider, in case of an error |
| error_description | String | The error description received by the payment gateway provider, in case of an error |
| payment_gateway_provider | Payment Gateway Provider Object | The payment gateway provider that will process the payment gateway request |
Accounts Receivable Object | The accounts receivable related with the retrieved payment gateway request | |
| payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference related with the retrieved payment gateway request |
| payment | Payment Object | The payment related with the retrieved payment gateway request |
| payment_cancellation | Payment Cancellation Object | The payment cancellation related with the retrieved payment gateway request |
| bill | Bill Object | The bill that was paid by the retrieved payment gateway request |
| wallet | Wallet Object | The wallet that was topped up by the retrieved payment gateway request |
| log_information | Log Information Object | The log information of the retrieved payment gateway request |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway provider |
name | String | The name of the retrieved payment gateway provider |
alternative_code | String | The alternative code of the retrieved payment gateway provider |
| description | String | The description of the retrieved payment gateway provider |
| payment_gateway | String | The provisioning protocol used by the payment gateway provider |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
|---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment preference |
account_holder | String | The account holder of the retrieved payment preference |
bank_account_number | String | The bank account number of the retrieved payment preference |
default | Boolean | Indicates if the retrieved payment preference is the default for the related accounts receivable |
| state | String | Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE Available from CRM.COM R15.0.0 |
use_for_recurring_payments | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable. Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained |
opt_in_for_subscriptions | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to its subscriptions. Available from CRM.COM R16.0.0 |
opt_in_for_purchases | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases. Available from CRM.COM R16.0.0 |
| notes | String | The notes of the retrieved payment preference object. Available from CRM.COM R10.1.0 |
| payment_medium_identifier | String | The payment medium identifier related with the retrieved payment preference Available from CRM.COM R11.0.0 |
iban | String | The international bank account number Available from CRM.COM R13.1.0 |
business_identifier_code | String | The business identifier code that identifies the bank Available from CRM.COM R13.1.0 |
unique_mandate_reference | Number | The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor Available from CRM.COM R13.1.0 |
mandate_signing_date | Date | The date that the mandate was signed Available from CRM.COM R13.1.0 |
| mandate_termination_date | Date | The date that the mandate will be terminated. No payments should be send after that date (inclusive) Available from CRM.COM R13.1.0 |
| payment_preference | Payment Preference Object | The payment preference of the retrieved payment preference |
Bank Account Type Object | The bank account type related with the retrieved payment preference | |
Bank Object | The bank related with the retrieved payment preference | |
Bank Branch Object | The bank branch related with the retrieved payment preference | |
| payment_medium_type | Payment Medium Type | The payment medium type related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| payment_medium_brand | Payment Medium Brand | The payment medium brand related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| default_card | Payment Gateway Card Objects | It defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. |
| cards_set | Set Payment Gateway Card Objects | The set of all payment gateway cards which are related with the specific accounts receivable payment preference |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment preference |
name | String | The name of the retrieved payment preference |
alternative_code | String | The alternative code of the retrieved payment preference |
| type | Sting | The type of the payment preference, such as
BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0 |
| description | Sting | The description of the retrieved payment preference |
Name | Type | Description |
id | String | The id of the retrieved bank account type |
name | String | The name of the retrieved bank account type |
alternative_code | String | The alternative code of the retrieved bank account type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank |
name | String | The name of the retrieved bank |
alternative_code | String | The alternative code of the retrieved bank |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank branch |
name | String | The name of the retrieved bank branch |
alternative_code | String | The alternative code of the retrieved bank branch |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium type |
name | String | The name of the retrieved payment medium type |
alternative_code | String | The alternative code of the retrieved payment medium type |
| description | String | The description of the retrieved payment medium type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium brand |
name | String | The name of the retrieved payment medium brand |
alternative_code | String | The alternative code of the retrieved payment medium brand |
| description | String | The description of the retrieved payment medium brand |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
default | Boolean | Indicates if the retrieved payment gateway card is the default for the related accounts receivable payment preference |
Payment Gateway Card Object | The represented payment gateway card |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment |
number | String | The number of the retrieved payment |
reference_number | String | The reference number of the retrieved payment |
life_cycle_state | String | The life cycle state of the payment. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED, PENDING_VERIFICATION |
| issued_on | Date | The date that the payment was issued |
| posted_on | Date | The date that the payment was posted |
| payment_amount | Number | The total amount of the payment |
| processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment cancellation |
number | String | The number of the retrieved payment cancellation |
reference_number | String | The reference number of the retrieved payment cancellation |
life_cycle_state | String | The life cycle state of the payment cancellation. the only available value is POSTED. |
| issued_on | Date | The date that the payment cancellation was issued |
| posted_on | Date | The date that the payment cancellation was posted |
| payment_amount | Number | The total amount of the payment cancellation |
| processed_by_payment_gateway | String | The payment gateway that processed the payment cancellation |
| payment_gateway_reference_number | String | A reference to the number of the payment cancellation that was created on the payment gateway |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved bill |
number | String | The number of the retrieved bill |
life_cycle_state | String | The life cycle state of the bill. One of the following values is returned: POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED |
| from_date | Date | The date from which the accounts receivable is billed for |
| to_date | Date | The date until which the accounts receivable is billed for |
| due_date | Date | The due date of bill. The field is calculated dynamically. The maximum due date of related invoices. Available from CRM.COM R12.4.0 |
| total_billed_amount | Number | The total billed amount |
| total_amount_to_be_paid | Number | The total amount to be paid |
| bill_status | String | The status of the bill in terms of it is settled or not.The supported values are the following: SETTLED, UNSETTLED, PARTIALLY_SETTLED |
| currency | Currency object | The bill's currency Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved wallet |
number | String | The number of the retrieved wallet |
| life_cycle_state | String | The life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED |
| accounts_receivable | Accounts Receivable Object | The account receivable related with the retrieved wallet |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
|---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
- No labels