V1.11.0 Changelog
Added
Modified (Older values highlighted with strikethrough)
Deprecated
Removed
EBPP API
-
Deprecated Get and Retrieve Recorded Payments API and merged them under Payments API
Customer
Create Customer
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer_accounts.list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Update Customer
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer_accounts.list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Customer
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer_accounts.list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Customers
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
list[n].customer_accounts.list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Customers Pagination
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
list[n].customer_accounts.list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Customer Account
Retrieve Customer Accounts
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Customer Accounts Pagination
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Customer Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Renew Customer Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Funding Account
Add Funding Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Update Funding Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Funding Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Delete Funding Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Funding Accounts
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Replace Funding Account
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Payment
Create Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
token string
- The token is used to uniquely identify the payment, such as the POS token.
- Max. Length: 64 Reg. Exp.: [0-9a-zA-Z._-]{0,64}
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : swiped_card, scanned_check, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Update Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
token string
- The token is used to uniquely identify the payment, such as the POS token.
- Max. Length: 64 Reg. Exp.: [0-9a-zA-Z._-]{0,64}
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : swiped_card, scanned_check, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
token string
- The token is used to uniquely identify the payment, such as the POS token.
- Max. Length: 64 Reg. Exp.: [0-9a-zA-Z._-]{0,64}
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : swiped_card, scanned_check, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Delete Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Simple Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer.comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
funding_account.comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer_account.comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Payments
Specification Changes
- Query Params
-
payment_method array
- The fulfillment method for the payment.
- Valid Values : ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].token string
- The token is used to uniquely identify the payment, such as the POS token.
- Max. Length: 64 Reg. Exp.: [0-9a-zA-Z._-]{0,64}
-
list[n].payment_method string
- The fulfillment method for the payment.
- Valid Values : swiped_card, scanned_check, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Fee Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
token string
- The token is used to uniquely identify the payment, such as the POS token.
- Max. Length: 64 Reg. Exp.: [0-9a-zA-Z._-]{0,64}
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : swiped_card, scanned_check, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Record Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer.comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
customer_account.comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Recorded Payments
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Recorded Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Delete Recorded Payment
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Payment Setup
Create Payment Setup
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Update Payment Setup
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Payment Setup
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Delete Payment Setup
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Payment Setups
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Refund
Create Refund
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Request Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Retrieve Refunds
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
list[n].comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-
Get Refund
Specification Changes
- Request Headers
-
trace_id string
- The unique reference that can be used for tracing and debugging an API call.
- Reg. Exp.: [a-zA-Z0-9_=-]{1,50}
-
- Response Body
-
comments string
- Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
- Max. Length: 1000 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+ [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"\r\n]+
-