Testing Corporate Credit
This guide explains how to test Corporate Credit (CC) transactions in the CV environment using the Program API. Do not follow this procedure to test in Production.
Along with this guide you might want to read these:
- Corporate Credit — Explanation of what Corporate Credit is, with use cases.
- Creating Corporate Credit Accounts — Properties of CC accounts and how to set them up.
- Corporate Credit Transaction Examples — How various Corporate Credit transaction types look in the ledger.
In this scenario you will:
- Create a CC funding account
- Set a credit limit
- Create one or more CC spending accounts
- Simulate a card authorization and settlement
- View the authorization/settlement as well as the funding transactions
- Adjust the available credit
Remember that the CV environment runs on Galileo system time.
Set up the products
Work with Galileo to set up your CC funding and CC spending products in CV. Galileo recommends that you configure all of the settings that you intend to use in Production.
CC funding product
At minimum, the funding product should have these characteristics:
- Product otype 0
- Product category 32
CC spending product
At minimum, the spending product should have this characteristic:
- Product category 33
Create the accounts
Follow these steps to create a CC funding and a CC spending account.
Create the CC funding account
- Call Create Account with these parameters:
Parameter | Value |
---|---|
firstName | CC Funding |
lastName | Account1 |
prodId | CC funding product ID |
businessName | Required if prodId is a business product. |
- In the response, capture the
pmt_ref_no
(PRN) for future use.
Activate the CC funding account
-
Check the status of the CC funding account by calling Verify Account with this parameter:
accountNo:
PRN of the CC funding account
-
If the
account_status
is notN
, activate the CC funding account by calling Modify Status with these parameters:
Parameter | Value |
---|---|
accountNo | pmt_ref_no of the CC funding account |
type | 1 |
Set the credit limit on the funding account
To set the credit limit on the CC funding account, call Set Corporate Credit Limit with these parameters:
Parameter | Value |
---|---|
accountNo | pmt_ref_no of the CC funding account |
amount | 1000 |
Create a CC spending account
- Call Create Account with these parameters.
Parameter | Value |
---|---|
firstName | Jane |
lastName | Schmidt |
prodId | CC spending product ID |
businessName | Required if prodId is a business product. |
fundingAccountNo | pmt_ref_no of the CC funding account |
- Capture the these values from the response:
pmt_ref_no
card_id
(CAD)- Last four digits of
card_number
expiry_date
card_security_code
- As desired, create a second CC spending account, such as a card with a different CC spending account product ID.
Activate the spending card
- After creating the CC spending card, call Activate Card with these parameters (See Card activation in Setting Up a Card Program for information about other activation options.):
Parameter | Value |
---|---|
accountNo | PRN or CAD of the CC spending account |
cardExpiryDate | expiry_date as YYYY-MM |
cardSecurityCode | card_security_code (In CV it is always 123) |
cardNumberLastFour | Optional. Last four digits of card_number. If there is more than one card associated with the PRN, you must populate this parameter. |
- To verify that the card has been activated, call Get Card with the PRN or CAD of the card for
accountNo
. Inside theembossed_cards
object you should seestatus: N
.
View account relationship
To see the relationship between the CC funding and CC spending accounts, call Get RTF Account Relationship with this parameter:
accountNo:
PRN of the CC funding account, which returns all of the spending accounts that are associated with it.
Alternatively, you can call the endpoint with a CC spending account PRN for accountNo
to return the associated CC funding account.
Perform transactions
- To simulate a simple card transaction in CV, call the Create Simulated Card Authorization endpoint with these parameters:
Parameter | Value |
---|---|
accountNo | PAN or CAD of the CC spending card |
amount | 10 |
association | mc_auth |
merchantName | Central Market |
currencyCode | Populate this parameter only when the currency of the program is not 840 (U.S. dollar): 124 (Canada), 484 (Mexico), or 170 (Colombia). |
- Capture the
auth_id
for future use. - Settle the transaction by calling the Create Simulated Card Settlement endpoint with these parameters:
Parameter | Value |
---|---|
accountNo | PAN or CAD of the CC spending card |
authId | The auth_id from the previous endpoint response. |
association | mc_auth |
amount | 10 or blank |
View the CC transactions
To see the transactions that were created, call Get All Transaction History twice:
accountNo
— PRN of the CC funding accountaccountNo
— PRN of the CC spending account
For the CC spending account you should see four transactions. The auth_id
and source_id
are example values only.
trans_code | amt | auth_id | source_id | calculated_balance |
---|---|---|---|---|
ADSY | 10 | 2222 | 4445 | 10 |
AUA | -10 | 2222 | 2222 | 0 |
BO5 | 10 | None | 2222 | 10 |
SE5 | -10 | 2222 | 2222 | 0 |
For the CC funding account, you should see one transaction.
trans_code | amt | auth_id | source_id | calculated_balance |
---|---|---|---|---|
ADFY | -10 | 2222 | 4444 | -10 |
Check the credit limit
For the funding account, call Get Corporate Credit Summary. This should be the result:
available_credit: 990
credit_limit: 1000
The cards can continue spending until the available_credit
reaches 0. After that, all authorization requests are denied until one of these events happens:
- The credit limit is increased.
- Funds are added to the funding account, such as to pay some or all of the balance.
Pay off the balance
For the CC funding account, call Get Balance. This should be the result:
balance: -10
That is the amount owed on the CC funding account. To pay it off, you can apply the funds to either the spending account or the funding account. If you apply funds to the spending account, they will be transferred into the funding account.
For this example, call Create Adjustment for the CC spending account with these parameters:
Parameter | Value |
---|---|
transactionId | Any unique 64-bit integer. In Postman you can use the {{$randomInt}} variable. (This is only for the Create Adjustment endpoint. All other endpoints can use a UUID or other format.) |
accountNo | PAN or PRN of the CC spending account |
amount | 10 |
type | RL |
debitCreditIndicator | C |
includeRtfTransfer | 1 or blank so that the funds will be automatically moved to the funding account. |
Alternatively, you can use Create Payment to apply the funds, using the same type
.
Add funds to the funding account
You do not need to add funds to the funding account for the spending cards to have available funds—setting a credit limit is enough. However, you can add funds in excess of the balance owed, which increases the available amount to spend.
Call Create Adjustment for the CC funding account with these parameters:
Parameter | Value |
---|---|
transactionId | Any unique 64-bit integer. |
accountNo | PRN of the CC funding account |
amount | 500 |
type | RL |
debitCreditIndicator | C |
includeRtfTransfer | 0 so that the adjustment will not affect the spending accounts. |
Call Get Corporate Credit Summary for the funding account. This should be the result:
available_credit: 1500
credit_limit: 1000
The available credit is higher than the credit limit by 500.00. The spending cards now have a 1500.00 spending limit, without your needing to change the credit limit.
Alternatively, you can call Set Corporate Credit Limit to set the credit limit to 1500.00 or any other limit.
Simulate a Visa transaction
To simulate a Visa transaction instead of the Mastercard transaction shown above, pass association: visa
. In the response to Get All Transaction History, the transaction codes will be:
- VIA — Authorization
- BVA — Backout
- VSA — Settlement
Note
For other types of transactions, see the Simulating Card Transactions guide.
Updated 8 months ago