Book Transfers

Overview

A book transfer is an internal transfer of funds between two accounts that exist in COS. The transfer is an atomic operation, which requires both a debit and credit account. The accounts can be either a master account or sub ledger, or any combination of the two.

In this example, we transfer $100 from one account to another:

POST /core/v1/transfers
{
  "debitAccountNumber": "1234567890",
  "creditAccountNumber": "9999999999",  
  "amount": 10000
}

This transfer request will result in a transaction being created and executed:

{
  "id": "b954ba97-31d9-4c7e-b2b0-a90b00d0669b",
  "traceNumber": "T181771238453M77E",
  "status": "Complete",
  "debit": {    
    "transactionType":"Debit",
    "accountType":"Deposit",
    "masterAccountNumber":"1234567890",
    "subAccountNumber":"1234567890",
    "partnerId":"eaf67ca7-f8b8-4e7c-9bd8-a8ea00f53d64",
    "productId":"f96bb66f-7afe-444d-96e8-a8eb00cfc1c9",
    "result":{
      "success":true,
      "code":"OK"
    }
  },
  "credit": {
    "transactionType":"Credit",
    "accountType":"Deposit",
    "masterAccountNumber":"9999999999",
    "subAccountNumber":"9999999999",
    "partnerId":"eaf67ca7-f8b8-4e7c-9bd8-a8ea00f53d64",
    "productId":"f96bb66f-7afe-444d-96e8-a8eb00cfc1c9",
    "result": {
      "success":true,
      "code":"OK"
    }
  },
  "transactionCode":"Account Transfer",
  "amount":10000,
  "description":"Transfer from 1234567890 to 9999999999",
  "rail":"Internal",
  "proposedAt":"2018-06-26T12:38:45-04:00",
  "executedAt":"2018-06-26T12:38:47-04:00",
  "lastModifiedAt":"2018-06-26T12:38:47.7228763-04:00"
}

Did this page help you?