2024
This changelog contains the changes that took place in 2024 in chronological order.
8 Jan 2025 v1.36
| Deployment Date | Environment |
|---|---|
| 8 Jan 2025 | UAT |
| 8 Jan 2025 | Production |
Modified endpoints:
- POST /customers/{customer_id}/cards - Create a new card for a customer by customer_id
- Properties
carrier_delivery_addressin CreateCardRequest model is set to mandatory. - Properties
delivery_method,delivery_address,contact_nameandcontact_numberin CreateCardRequest model are deleted.
- Properties
- POST /cards/{card_id}/replace - Replace a card by card_id
- Properties
carrier_delivery_addressin ReplaceCardRequest model is set to mandatory. - Properties
delivery_method,delivery_address,contact_nameandcontact_numberin ReplaceCardRequest model are deleted.
- Properties
- GET /cards/{card_id} - Retrieve card details by card_id
- Properties
carrier_delivery_addressin InquiryCardResponse model is set to mandatory. - Properties
delivery_method,delivery_address,contact_nameandcontact_numberin InquiryCardResponse model are deleted.
- Properties
- POST /corporates/accounts/{corporate_account_id}/outgoing-credit-transfer - Initiate SCT payment
- Property
bank_countryin CreditorRequest model is set to mandatory.
- Property
- POST /accounts/{account_id}/outgoing-credit-transfer - Initiate SCT payment
- Property
bank_countryin CreditorRequest model is set to mandatory.
- Property
29 Nov 2024 v1.35
| Deployment Date | Environment |
|---|---|
| 29 Nov 2024 | UAT |
| 29 Nov 2024 | Production |
Modified endpoints:
- POST /accounts/{account_id}/transfer/{creditor_account_id} _- Transfer funds from customer account to another customer account
- Response model name was changed from
BalanceResponsetoTransferBalanceResponse. The model contains propertiesdebit_transaction_idandcredit_transaction_idwhilsttransaction_idwas deleted.
- Response model name was changed from
25 Nov 2024 v1.34
| Deployment Date | Environment |
|---|---|
| 25 Nov 2024 | UAT |
| 25 Nov 2024 | Production |
Modified endpoints:
- POST /customers/{customer_id}/cards - Create a new card for a customer by customer_id
- Added properties
carrier_delivery_addressandbulk_delivery_addressin CreateCardRequest model which will represent the carrier delivery address and the bulk delivery address of the card and will be used for card printing (these will be replacing propertiesdelivery_address,contact_nameandcontact_numberin a future release).
- Added properties
- POST /cards/{card_id}/replace - Replace a card by card_id
- Added properties
carrier_delivery_addressandbulk_delivery_addressin ReplaceCardRequest model which will represent the carrier delivery address and the bulk delivery address of the card and will be used for card printing (these will be replacing propertiesdelivery_address,contact_nameandcontact_numberin a future release).
- Added properties
- GET /cards/{card_id} - Retrieve card details by card_id
- Added properties
carrier_delivery_addressandbulk_delivery_addressin InquiryCardResponse model which will represent the carrier delivery address and the bulk delivery address of the card and will be used for card printing (these will be replacing propertiesdelivery_address,contact_nameandcontact_numberin a future release).
- Added properties
15 Oct 2024 v1.33
| Deployment Date | Environment |
|---|---|
| 15 Oct 2024 | UAT |
| 15 Oct 2024 | Production |
Modified endpoints:
- POST /corporates/{corporate_id}/individual - Create a new corporate individual
- Property
typein CorporateIndividualExchange model will be deleted (propertytypesthat accepts a list of enum valuesCorporateIndividualTypewill be replacing this property). - Property
typesin CorporateIndividualExchange model will be set to mandatory. At least one value must be provided in the list.
- Property
- GET /corporates/{corporate_id} _- Retrieve the details of a corporate by Id.
- Property
typein CorporateIndividualExchange model will be deleted (propertytypesthat accepts a list of enum valuesCorporateIndividualTypewill be replacing this property).
- Property
08 Oct 2024 v1.32
| Deployment Date | Environment |
|---|---|
| 08 Oct 2024 | UAT |
| 08 Oct 2024 | Production |
Modified endpoints:
- PUT /control/spend/{id} - Update a control spend group by id
- Updated request model from 'SpendExchange' to 'UpdateSpendControlRequest' to remove property
binas this cannot be updated.
- Updated request model from 'SpendExchange' to 'UpdateSpendControlRequest' to remove property
01 Oct 2024 v1.31
| Deployment Date | Environment |
|---|---|
| 01 Oct 2024 | UAT |
| 01 Oct 2024 | Production |
Modified endpoints:
- POST /corporates/{corporate_id}/individual - Create a new corporate individual
- Adding a new optional property
typesin CorporateIndividualExchange model that accepts a list of enum valuesCorporateIndividualType(this property will be replacing propertytypein a future release). If both properties(typesandtype) are provided, the values in propertytypestakes precedency.
- Adding a new optional property
- GET /corporates/{corporate_id} _- Retrieve the details of a corporate by Id.
- Adding a new property
typesin CorporateIndividualExchange model that returns a list of enum valuesCorporateIndividualType(this property will be replacing propertytypewhich will be deleted).
- Adding a new property
| Deployment Date | Environment |
|---|---|
| 19 Sep 2024 | UAT |
| 01 Oct 2024 | Production |
Modified webhook:
- POST payment.status - A status update on a payment that has been received/sent to/from an account Id
- Property
payment_statuswill return ISO20022 status codes.
- Property
24 Sep 2024 v1.30
| Deployment Date | Environment |
|---|---|
| 24 Sep 2024 | UAT |
| 24 Sep 2024 | Production |
Modified endpoints:
- GET /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corporate account id
- Adding enum values
SepaOutgoingPaymentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints.
- Adding enum values
- GET /corporate/accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by corporate account id and transaction id
- Adding enum values
SepaOutgoingPaymentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints.
- Adding enum values
17 Sep 2024 v1.29
| Deployment Date | Environment |
|---|---|
| 17 Sep 2024 | UAT |
| 17 Sep 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Regular expression of property
valuein CreateIdentificationRequest model was updated to^[A-Za-z0-9' ]{1,20}$ - Full name of a customer (first_name + whitespace + last_name) must be smaller or equal to 70 characters
- Regular expression of property
- PATCH /customers/{customer_id} - Update a customer by customer_id
- Full name of a customer (first_name + whitespace + last_name) must be smaller or equal to 70 characters
- PATCH /customers/{customer_id}/identifications - Update the identification of a customer by customer_id
- Regular expression of property
valuein UpdateIdentificationRequest model was updated to^[A-Za-z0-9' ]{1,20}$
- Regular expression of property
- GET /customers/{customer_id} - Retrieve a customer by customer_id
- Regular expression of property
valuein IdentificationExchange model was updated to^[A-Za-z0-9' ]{1,20}$
- Regular expression of property
- GET /customers - Retrieve customers
- Regular expression of property
identification_valuein SearchCustomerRequest model was updated to^[A-Za-z0-9' ]{1,20}$
- Regular expression of property
10 Sep 2024 v1.28
| Deployment Date | Environment |
|---|---|
| 10 Sep 2024 | UAT |
| 10 Sep 2024 | Production |
Modified endpoints:
- POST /accounts/{account_id}/credit - Credit the account id
- Property
transaction_codewill be mandatory
- Property
- POST /accounts/{account_id}/debit - Debit the account id
- Property
transaction_codewill be mandatory
- Property
- GET /accounts/{account_id}/transactions - Retrieve all transactions by account id
- Enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewill now be returned according to the transaction codes used in the credit and debit endpoints.
- Enum values
- GET /cards/{card_id}/transactions - Retrieve all transactions by card id
- Enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewill now be returned according to the transaction codes used in the credit and debit endpoints.
- Enum values
- GET /accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by account id and transaction id
- Enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewill now be returned according to the transaction codes used in the credit and debit endpoints.
- Enum values
- GET /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corproate account id
- Enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPayment,SepaOutgoingPayment,SepaIncomingPaymentAdjustmentandSepaOutgoingPaymentAdjustmentin propertyprocessing_code_typewill now be returned according to the transaction codes used in the credit and debit endpoints.
- Enum values
- GET /corporate/accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by corproate account id and transaction id
- Enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPayment,SepaOutgoingPayment,SepaIncomingPaymentAdjustmentandSepaOutgoingPaymentAdjustmentin propertyprocessing_code_typewill now be returned according to the transaction codes used in the credit and debit endpoints.
- Enum values
29 Aug 2024 v1.27
| Deployment Date | Environment |
|---|---|
| 29 Aug 2024 | UAT |
| 29 Aug 2024 | Production |
Modified endpoints:
- GET /accounts/{account_id}/transactions - Retrieve all transactions by account id
- Paging sizing to change from 500 to 50
- Adding enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints (currently these have only been added in the documentation, they will be returned in the endpoint responses in a future release).
- GET /cards/{card_id}/transactions - Retrieve all transactions by card id
- Paging sizing to change from 500 to 50
- Adding enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints (currently these have only been added in the documentation, they will be returned in the endpoint responses in a future release).
- GET /accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by account id and transaction id
- Adding enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPaymentandSepaOutgoingPaymentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints (currently these have only been added in the documentation, they will be returned in the endpoint responses in a future release).
- Adding enum values
- GET /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corporate account id
- Paging sizing to change from 500 to 50
- Adding enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPayment,SepaOutgoingPayment,SepaIncomingPaymentAdjustmentandSepaOutgoingPaymentAdjustmentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints (currently these have only been added in the documentation, they will be returned in the endpoint responses in a future release).
- GET /corporate/accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by corporate account id and transaction id
- Adding enum values
AccountLoad,CashLoad,CreditCardLoad,DebitCardLoad,VoucherLoad,SepaIncomingPayment,SepaOutgoingPayment,SepaIncomingPaymentAdjustmentandSepaOutgoingPaymentAdjustmentin propertyprocessing_code_typewhich will be returned according to the transaction codes used in the credit and debit endpoints (currently these have only been added in the documentation, they will be returned in the endpoint responses in a future release).
- Adding enum values
20 Aug 2024 v1.26
| Deployment Date | Environment |
|---|---|
| 20 Aug 2024 | UAT |
| 20 Aug 2024 | Production |
Modified endpoints:
- POST /accounts/{account_id}/credit - Credit the account id
- Adding new optional property
transaction_codewith regular expression^(?:[Aa]ccount[Ll]oad|[Cc]redit[Cc]ard[Ll]oad|[Dd]ebit[Cc]ard[Ll]oad|[Cc]ash[Ll]oad|[Ss]epa[Ii]ncoming[Pp]ayment|[Ss]epa[Oo]utgoing[Pp]ayment|[Vv]oucher[Ll]oad)$, which will represent the type of credit that is being credited onto the customer account
- Adding new optional property
- POST /accounts/{account_id}/debit - Debit the account id
- Adding new optional property
transaction_codewith regular expression^(?:[Aa]ccount[Ll]oad|[Cc]redit[Cc]ard[Ll]oad|[Dd]ebit[Cc]ard[Ll]oad|[Cc]ash[Ll]oad|[Ss]epa[Ii]ncoming[Pp]ayment|[Ss]epa[Oo]utgoing[Pp]ayment|[Vv]oucher[Ll]oad)$, which will represent the type of debit that is being debited onto the customer account
- Adding new optional property
31 Jul 2024 v1.25
| Deployment Date | Environment |
|---|---|
| 30 Jul 2024 | UAT |
| 31 Jul 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Regular expression of properties
first_nameandlast_namein CreateCardRequest model was updated to^(?!.*(?:^|\s|$)[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1}(?:^|\s|$))[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1,50}$ - Regular expression of properties
landline_numberandmobile_numberin CreateCardRequest model was updated to^\+[1-9]\d{7,14}$ - Regular expression of property
phonein CreateRecoveryRequest model was updated to^\+[1-9]\d{7,14}$
- Regular expression of properties
- GET /customers/{customer_id} - Retrieve customer details by customer_id
- Regular expression of properties
first_nameandlast_namein InquiryCustomerResponse model was updated to^(?!.*(?:^|\s|$)[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1}(?:^|\s|$))[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1,50}$ - Regular expression of property
numberin PhoneExchange model was updated to^\+[1-9]\d{7,14}$
- Regular expression of properties
- PATCH /customers/{customer_id} - Update customer details by customer_id
- Regular expression of properties
first_nameandlast_namein UpdateCustomerResponse model was updated to^(?!.*(?:^|\s|$)[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1}(?:^|\s|$))[^0-9_!¡?÷¿\/\\+=@#$%ˆ&*(){}|~<>;:[\]]{1,50}$
- Regular expression of properties
- PATCH /customers/{customer_id}/phones - Update customer phones by customer_id
- Regular expression of property
numberin PhoneExchange model was updated to^\+[1-9]\d{7,14}$
- Regular expression of property
29 Jul 2024 v1.24
| Deployment Date | Environment |
|---|---|
| 29 Jul 2024 | UAT |
| 29 Jul 2024 | Production |
Modified endpoints:
- POST /accounts/{account_id}/credit - Credit the account id
- Property
fee_amountwas removed from model CreditDebitRequest
- Property
- POST /accounts/{account_id}/debit - Debit the account id
- Property
fee_amountwas removed from model CreditDebitRequest
- Property
- POST /accounts/{account_id}/transfer/{creditor_account_id} - Transfer funds from account_id to creditor_account_id
- Property
fee_amountwas removed from model CreditDebitRequest
- Property
22 Jul 2024 v1.23
| Deployment Date | Environment |
|---|---|
| 22 Jul 2024 | UAT |
| 22 Jul 2024 | Production |
Modified endpoints:
- POST /accounts/{account_id}/outgoing-credit-transfer - Initiate SCT payment
- Regular expression of property
end_to_end_idin OutgoingCreditTransferRequest model was updated to^[A-Za-z0-9]{1,18}$
- Regular expression of property
12 Jul 2024 v1.22
| Deployment Date | Environment |
|---|---|
| 15 Jul 2024 | UAT |
| 17 Jul 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Regular expression of properties
emboss_nameandemboss_fourth_linein CreateCardRequest model was updated to^[A-Z -.]{1,21}$ - Property
delivery_methodin CreateCardRequest model was changed from type enum to string - Added new properties
user_defined_1,user_defined_2,user_defined_3anduser_defined_4to the CreateCardRequest model which are used for the card vendor - Property
kyc_levelin CreateCustomerRequest model was changed from type enum to string - Property
account_identifier_statusin CreateAccountResponse model was changed from type enum to string
- Regular expression of properties
- POST /customers/{customer_id}/cards - Create a new card for a customer by customer_id
- Regular expression of properties
emboss_nameandemboss_fourth_linein CreateCardRequest model was updated to^[A-Z -.]{1,21}$ - Property
delivery_methodin CreateCardRequest model was changed from type enum to string - Added new properties
user_defined_1,user_defined_2,user_defined_3anduser_defined_4to the CreateCardRequest model which are used for the card vendor
- Regular expression of properties
- POST /customers/{customer_id}/accounts - Create a new account for a customer by customer_id
- Property
account_identifier_statusin CreateAccountResponse model was changed from type enum to string
- Property
10 Jul 2024 v1.21
| Deployment Date | Environment |
|---|---|
| 10 Jul 2024 | UAT |
| 10 Jul 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Property
kyc_levelin the CreateCustomerRequest model will be set to required
- Property
3 Jul 2024 v1.20
| Deployment Date | Environment |
|---|---|
| 3 Jul 2024 | UAT |
| 3 Jul 2024 | Production |
Modified endpoints:
- POST /corporate - Creates a new corporate
- Properties
tax_residencyandaddresswas set to required
- Properties
- POST /corporates/{corporate_id}/individual - Create a new corporate individual
- Property
residence_countrywas set to required
- Property
27 Jun 2024 v1.19
| Deployment Date | Environment |
|---|---|
| 27 Jun 2024 | UAT |
| 27 Jun 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Added property
assign_account_identifierin the CreateAccountRequest model - Added property
account_identifier_statusin the CreateAccountResponse model
- Added property
- POST /customers/{customer_id}/accounts - Create new accounts
- Added property
assign_account_identifierin the CreateAccountRequest model - Added property
account_identifier_statusin the CreateAccountResponse model
- Added property
25 Jun 2024 v1.18
| Deployment Date | Environment |
|---|---|
| 25 Jun 2024 | UAT |
| 25 Jun 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- Added property
kyc_levelin the CreateCustomerRequest model which is currently not required
- Added property
- GET /customers/{customer_id} - Retrieve customer details by customer_id
- Added property
kyc_levelin the InquiryCustomerResponse
- Added property
21 Jun 2024 v1.17
| Deployment Date | Environment |
|---|---|
| 21 Jun 2024 | UAT |
| 21 Jun 2024 | Production |
Modified endpoints:
- POST /corporate _- Creates a new corporate.
- Added the properties
tax_residencyandaddressin the request model which are currently not required
- Added the properties
- POST /corporates/{corporate_id}/individual _- Create a new corporate individual
- Added the property
residence_countryin the request model which are currently not required
- Added the property
- GET /corporates/{corporate_id} _- Retrieve the details of a corporate by Id.
- Added the properties
tax_residencyandaddressin the response model - Added the property
residence_countryto the InquireCorporateIndividualResponse model
- Added the properties
28 May 2024 v1.16
| Deployment Date | Environment |
|---|---|
| 28 May 2024 | UAT |
| 28 May 2024 | Production |
Modified endpoints:
- GET /accounts/{account_id}/transactions - Retrieve all transactions by account id
- Property
account_currencycan return a null value - Property
response_coderesponse type will change from enum TransactionResponseCode to string - Adding property
cardholder_idwhich will represent the cardholder Id that the card belongs to
- Property
- GET /cards/{card_id}/transactions - Retrieve all transactions by card id
- Property
account_currencycan return a null value - Property
response_coderesponse type will change from enum TransactionResponseCode to string - Adding property
cardholder_idwhich will represent the cardholder Id that the card belongs to
- Property
- GET /accounts/{account_id}/transactions/{transaction_id} - Retrieve all the details of a transactions by account id and transaction id
- Property
account_currencycan return a null value - Property
response_coderesponse type will change from enum TransactionResponseCode to string - Adding property
cardholder_idwhich will represent the cardholder Id that the card belongs to - Adding property
posting_response_codewhich will provide more details of a reversed or force post transaction - Removing property
network_response_code
- Property
- GET /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corproate account id
- Property
account_currencycan return a null value - Property
response_coderesponse type will change from enum TransactionResponseCode to string
- Property
- GET /corporate/accounts/{corporate_account_id}/transactions/{transaction_id} - Retrieve all the details of a transactions by corporate account Id and transaction id
- Property
account_currencycan return a null value - Property
response_coderesponse type will change from enum TransactionResponseCode to string - Removing property
network_response_code
- Property
6 May 2024 v1.15
| Deployment Date | Environment |
|---|---|
| 10 May 2024 | UAT |
| 10 May 2024 | Production |
Modified endpoints:
- GET /accounts/{account_id}/transactions - Retrieve all transactions by account id
- Making properties
page_numberandpage_sizemandatory in the response model
- Making properties
- GET /cards/{card_id}/transactions - Retrieve all transactions by card id
- Making properties
page_numberandpage_sizemandatory in the response model
- Making properties
- GET /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corproate account id
- Making properties
page_numberandpage_sizemandatory in the response model
- Making properties
3 May 2024 v1.14
Modified endpoints:
- POST /accounts/{account_id}/transactions - Retrieve all transactions by account Id
- Added the properties
page_numberandpage_sizein the response model - Added the property
transactionsinstead of an generic array in the response model
- Added the properties
- POST /cards/{card_id}/transactions - Retrieve all transactions by card Id
- Added the properties
page_numberandpage_sizein the response model - Added the property
transactionsinstead of an generic array in the response model
- Added the properties
- POST /corporate/accounts/{corporate_account_id}/transactions - Retrieve all transactions by corproate account Id
- Added the properties
page_numberandpage_sizein the response model - Added the property
transactionsinstead of an generic array in the response model
- Added the properties
22 April 2024 v1.13
| Deployment Date | Environment |
|---|---|
| 25 April 2024 | UAT |
| 25 April 2024 | Production |
Modified endpoints:
- POST /customers - Create new customer
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the accounts and cards provided where created or not. Going forward, the below changes will occur:
- If the customer is created successfully and all OR partial from the array of accounts and cards provided were created successfully, http status code 206 will be returned and in the response body, only the accounts and cards that were created successfully will be displayed
- In the response model, a new property
request_position_indexwill be returned which will reflect the position of the accounts and card in the request body received - In the CreateCardRequest model, property
accountswill be removed
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the accounts and cards provided where created or not. Going forward, the below changes will occur:
- POST /customers/{customer_id}/accounts - Create new accounts for a customer by customer_id
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the accounts where created or not. Going forward, the below changes will occur:
- If all accounts fail to be created, an errorous http status code will be returned
- In the response model, a new property
request_position_indexwill be returned which will reflect the position of the account in the request body received - If only partial from the array of accounts provided were created successfully, http status code 206 will be returned and in the response body, only the accounts that were created successfully will be displayed
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the accounts where created or not. Going forward, the below changes will occur:
- POST /customers/{customer_id}/cards - Create new cards for a customer by customer_id
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the cards where created or not. Going forward, the below changes will occur:
- If all cards fail to be created, an errorous http status code will be returned
- In the response model, a new property
request_position_indexwill be returned which will reflect the position of the card in the request body received - If only partial from the array of cards provided were created successfully, http status code 206 will be returned and in the response body, only the cards that were created successfully will be displayed
- In the CreateCardRequest model, property
accountswill be removed
- In past versions, this endpoint was almost always returning http status code 200, irrelevant of whether the cards where created or not. Going forward, the below changes will occur:
- GET /cards/{card_id} - Retrieve card details by card_id
- Removing property
accountsfrom the InquiryCardResponse model
- Removing property
08 April 2024 v1.12
Modified endpoints:
- POST /control/spend - Add a control spend group
- Added property
is_enabledin the SpendConfigurationExchange model
- Added property
- Get /control/spend/{id} - Retrieves a control spend group by id
- Added property
is_enabledin the SpendConfigurationExchange model
- Added property
20 March 2024 v1.11
Modified endpoints:
- GET /accounts/{account_id}/transactions/{transaction_id} - Retrieve transaction details by account_id and transaction_id
- Removed property
merchant_idin model TransactionDetailedResponse - Added property
card_acceptor_idin model TransactionDetailedResponse
- Removed property
- GET /customers/{customer_id} - Retrieve customer details by customer_id
- Added property
account_identifierin model InquiryAccountResponse
- Added property
14 March 2024 v1.10
Modified endpoints:
- POST /customers - Create new customer
- Removed properties
yearly_income,monthly_spend,monthly_loadandnet_worthfrom the CreateRiskProfileRequest model - Regular expression of property
professionin CreateRiskProfileRequest model was updated to^(?:Director_Owner|Executive|Manager|Employee_Worker|SelfEmployed|Student|Retiree|Unemployed|TemporaryEmployee)$ - Regular expression of property
account_purposein CreateRiskProfileRequest model was updated to^(?:ReceiveSocialWelfare|ReceiveSalary|PayBills|PersonalExpenses|BusinessIncome|MoneyTransfers|Abroad|Gaming_Betting|POSPurchases|Savings|Cryptocurrency|TravelExpenses|BusinessExpenses)$ - Regular expression of property
monthly_incomein CreateRiskProfileRequest model was updated to^(?:LessThan500|501To1000|1001To1500|1501To2000|2001To3000|GreaterThan3000)$
- Removed properties
- GET /customers/{customer_id} - Retrieve customer details by customer_id
- Removed properties
yearly_income,monthly_spend,monthly_loadandnet_worthfrom the InquiryRiskProfileResponse model - Regular expression of property
professionin InquiryRiskProfileResponse model was updated to^(?:Director_Owner|Executive|Manager|Employee_Worker|SelfEmployed|Student|Retiree|Unemployed|TemporaryEmployee)$ - Regular expression of property
account_purposein InquiryRiskProfileResponse model was updated to^(?:ReceiveSocialWelfare|ReceiveSalary|PayBills|PersonalExpenses|BusinessIncome|MoneyTransfers|Abroad|Gaming_Betting|POSPurchases|Savings|Cryptocurrency|TravelExpenses|BusinessExpenses)$ - Regular expression of property
monthly_incomein InquiryRiskProfileResponse model was updated to^(?:LessThan500|501To1000|1001To1500|1501To2000|2001To3000|GreaterThan3000)$
- Removed properties
- PATCH /customers/{customer_id} - Update a customer by customer_id
- Removed properties
yearly_income,monthly_spend,monthly_loadandnet_worthfrom the UpdateRiskProfileRequest model - Regular expression of property
professionin UpdateRiskProfileRequest model was updated to^(?:Director_Owner|Executive|Manager|Employee_Worker|SelfEmployed|Student|Retiree|Unemployed|TemporaryEmployee)$ - Regular expression of property
account_purposein UpdateRiskProfileRequest model was updated to^(?:ReceiveSocialWelfare|ReceiveSalary|PayBills|PersonalExpenses|BusinessIncome|MoneyTransfers|Abroad|Gaming_Betting|POSPurchases|Savings|Cryptocurrency|TravelExpenses|BusinessExpenses)$ - Regular expression of property
monthly_incomein UpdateRiskProfileRequest model was updated to^(?:LessThan500|501To1000|1001To1500|1501To2000|2001To3000|GreaterThan3000)$
- Removed properties
12 March 2024 v1.9
Modified endpoints:
- POST /control/spend - Add a control spend group
- Removed properties
merchantandcard_acceptorin the SpendConfigurationExchange model - Added properties
merchant_category_codes,merchant_ids,terminal_locationsandterminal_idsin the SpendConfigurationExchange model
- Removed properties
- Get /control/spend/{id} - Retrieves a control spend group by id
- Removed properties
merchantandcard_acceptorin the SpendConfigurationExchange model - Added properties
merchant_category_codes,merchant_ids,terminal_locationsandterminal_idsin the SpendConfigurationExchange model
- Removed properties
- PATCH /control/spend/{id} - Update a control spend group by id
- Removed properties
merchantandcard_acceptorin the SpendConfigurationExchange model - Added properties
merchant_category_codes,merchant_ids,terminal_locationsandterminal_idsin the SpendConfigurationExchange model
- Removed properties
09 February 2024 v1.8
Modified endpoints:
- POST /customers - Create new customer
- Added property
line_3to the AddressExchange model which will represent the third line in the address - Added property
cardholder_idto the CreateCardResponse model which will represent the cardholder id of the card created - Added new properties
emboss_fourth_line,contact_name,contact_numberanddelivery_methodto the CreateCardRequest model which are used for card printing
- Added property
- POST /customers/{customer_id}/cards - Create a new card for a customer by customer_id
- Added property
line_3to the AddressExchange model which will represent the third line in the address - Added property
cardholder_idto the CreateCardResponse model which will represent the cardholder id of the card created - Added new properties
emboss_fourth_line,contact_name,contact_numberanddelivery_methodto the CreateCardRequest model which are used for card printing
- Added property
- PATCH /customers/{customer_id}/addresses - Update a customer address by customer_id
- Added property
line_3to the UpdateAddressRequest model which will represent the third line in the address
- Added property
- GET /customers/{customer_id} - Retrieve customer details by customer_id
- Added property
line_3to the AddressExchange model which will represent the third line in the address - Added property
cardholder_idto the InquiryCustomerCardResponse model which will represent the cardholder id of the card created - Added property
created_dateto the InquiryCustomerResponse model which will represent the cardholder id of the card created
- Added property
- GET /customers/{customer_id}/cards/{card_id} - Retrieve card details by customer_id and card_id
- Added property
line_3to the AddressExchange model which will represent the third line in the address - Added new properties
cardholder_id,delivery_address,emboss_fourth_line,contact_name,contact_numberanddelivery_methodto the InquiryCardResponse model
- Added property
11 January 2024 v1.7
Modified endpoints:
- POST /customers - Create new customer
- Added property
delivery_addressto the CreateCustomerRequest model which will represent the address to where the card will be delivered
- Added property
- POST /customers/{customer_id}/cards - Create a new card for a customer by customer_id
- Added property
delivery_addressto the CreateCardRequest model which will represent the address to where the card will be delivered
- Added property