Card to Bank Transfer
From the CoreCard account, money can be transferred to an account in some other bank also. External bank account recipients need to be added along with their name and routing number before initiating a transfer. Multiple recipients can be maintained in the CoreCard system.
CardToBankAccountTransfer
Action: POST
Endpoint: /api/CardToBankAccountTransfer
Use this API to transfer funds from card account to external bank Account only when the status of bank account and card is active. A valid card number and transaction amount should be provided as input for a successful transfer.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
DecisionFlag string Mandatory |
Used for performing various operations when respective flag values defined below are passed. 1 = To Get Recipient ID, Recipient Name and Nick Name etc. 2 = Fund Transfer from Card to Bank. 3 = Adding a new Recipient Bank Account. 4 = Fund Transfer from Card to Bank by given Recipient Bank Account information. 5 = Delete Recipient Bank Account information. 6 = Get Recipient Bank Account information. 7 = Update Recipient Bank Account information. 8 = Set Recipient Bank Account Active/Inactive. Allowable Values: 2 |
TransferType string Mandatory |
Type of money transfer. Valid values: 0 = Card To Bank 1 = Bank To Card Example: 0 Condition :0 (Card To Bank) is applicable for decision flags 1,2,3,4,5,6,7 and 8. 1 (Bank To Card) is applicable for decision flags 1,3,5 and 7 only. Allowable Values: 1 |
FromCardNumber string Conditional |
Clear Card Number of the cardholder from where a transaction is initiated. Valid values: 0-9 Example: 123456******0001 Condition : At least one of From Card Number/ From Proxy Number is required. Allowable Values: 16 |
FromProxyNumber string Conditional |
Proxy Number of the cardholder from where a transaction is initiated Valid values:0-9 Example:1005 Condition : At least one of From Card Number/ From Proxy Number is required. Allowable Values: 19 |
RecipientId Int64 Conditional |
UniqueID of Recipient. Valid Values:0-9 Example:1234567890 Condition: It is Mandatory when DecisionFlag = 2,5,6,7 and 8 |
RecipientName string Conditional |
First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick Condition: It is mandatory for below scenario: DecisionFlag = 3 and TransferType = 1 or 0, DecisionFlag = 4 and TransferType = 0 Allowable Values: 50 |
AccountNickName string Conditional |
Nick name of the account Valid Values:A-Z,a-z Example: Sem Condition: It is mandatory when DecisionFlag = 3 and 4. Allowable Values: 50 |
TranactionAmount decimal Optional |
Transaction Amount Valid Values: 0-9 Example:100.11 Condition:It is Mandatory when DecisionFlag = 2 and 4. |
AccountType string Conditional |
Type of account. Valid Values: 0 = Checking 1 = Savings Example:0 Condition: It is Mandatory when DecisionFlag =3 and 4. Allowable Values: 9 |
ConfirmBankAccountNumber string Conditional |
Re-enter Cardholder's Bank Account Number for confirmation Valid Values:0-9 Example: 1122345678 Condition: It is Mandatory when DecisionFlag =3,4 and 7 Allowable Values: 17 |
BankAccountNumber string Conditional |
Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678 Condition: It is Mandatory when DecisionFlag =3,4 and 7 Allowable Values: 17 |
RoutingNumber string Conditional |
Bank Routing Number Valid Values:0-9 Example:0110000015 Condition: It is Mandatory when DecisionFlag = 3,4 and 7 Allowable Values: 9 |
ReasonDescription string Optional |
Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason Allowable Values: 50 |
Note string Optional |
Notes entered by the user Valid Values : A-Z,0-9 Example : Card found Allowable Values: 396 |
BankStatus string Conditional |
Status of Bank Account. Valid Values :1 = Active 0 = Inactive Example : 1 Condition: It is mandatory for Decision Flag = 8. Allowable Values: 1 |
ExternalBankStatus string Conditional |
External Bank Account Status. Valid Values: 0-7 Example:1 (Validated) Appendix Section:ExternalBankStatus Condition: It is Mandatory when DecisionFlag = 7 or 3 Allowable Values: 2 |
SameDayACHType string Optional |
For sending transaction in Same Day ACH file, use this field. Valid values: SD1300 or SD1700 Example: SD1300 Allowable Values: 6 |
FromWalletID Int32 Conditional |
Wallet ID of wallet mapped on account Valid values: 0-9 Example: 1005 Condition: Mandatory when card product structure is multi wallet. Allowable Values: 10 |
TransactionAmount decimal Conditional |
Transaction Amount Valid Values: 0-9 Example:100.11 Condition:It is Mandatory when DecisionFlag = 2 and 4. |
Sample Request Body
{ "APIVersion": "1.5", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "DecisionFlag": "1", "TransferType": "0", "FromCardNumber": "", "FromProxyNumber": "1316605", "FromWalletID": 1001, "RecipientId": 176270, "RecipientName": "Harshal", "AccountNickName": "", "TransactionAmount": 20.0, "AccountType": "1", "ConfirmBankAccountNumber": "60000000027166", "BankAccountNumber": "60000000027166", "RoutingNumber": "061120835", "ReasonDescription": "", "Note": "", "BankStatus": "1", "ExternalBankStatus": "", "SameDayACHType": "SD1700" }
Response Fields Detail
Fields | Description |
---|---|
TransactionId Int64 |
Transaction ID of Debit Transaction on Source Card. |
BankAccountNumber string |
Cardholder's Bank Account Number Valid Values:0-9 Example: 1122345678 Allowable Values: 11 |
AccountType string |
Type of account. Valid Values: 0 =Checking 1 =Savings Example:0 Allowable Values: 3 |
RoutingNumber string |
Bank Routing Number Valid Values:0-9 Example:0110000015 Allowable Values: 9 |
FinancialInstituteName string |
Name of Financial Institution Valid Values:A-Z,a-z Example:FEDERAL RESERVE BANK Allowable Values: 200 |
RecipientName string |
First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick Allowable Values: 50 |
RecipientNameId array |
List of Recipient Name Id. |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "TransactionId": 2154696549, "BankAccountNumber": "60000000027166", "AccountType": "1", "RoutingNumber": "061120835", "FinancialInstituteName": "FIRST COVENANT BANK", "RecipientName": "Harshal", "RecipientNameId": [ { "RecipientId": 175937, "AccountNickName": "Harsh", "RecipientName": "Harshal", "AddedBankStatus": "", "TransferType": "1" } ] } }