Card Transfers

Card Transfer Funds

This endpoint enables clients to transfer funds to and from a card.

Move funds from a Customer Account to a card by calling the following endpoint. The customerAssetAccountsId must be either a USD (excluding subledger) or dUSD account.

• Endpoint: /api/v1/customer/cards/topup

• Method: POST

Note: Clients may use dUSD or USD accounts interchangably. For subledger customers, the CustomerAssetAccountId of the dUSD Account should be used. For other account types, you should use a USD Account.

Request Body Example

{
  "CustomerAssetAccountsId": 1001,
  "CardsId": 1234,
  "Amount": 10,
  "Reference": "Top Up Funds",
  "Type": "Deposit" // Deposit or Withdraw
}

Success Response Example

{
    "id": 30939,
    "details": {
        "FromTransactionId": 30939,
        "ToTransactionId": 30941,
        "FeeTransactionId": 30940,
        "amount": -10,
        "feeAmount": 0,
        "description": "Card transfer - Top Up Funds",
        "dateTime": "2024-02-15T17:05:09.97+00:00",
        "bPending": true
    },
    "status": "1",
    "errors": []
}

---

Card to Card Transfer

• Endpoint: /api/v1/customer/cards/movefunds

• Method: POST

Move funds to and from managee's card

post

Request body parameters:

• FromCardsId
• ToCardsId
• Amount

Possible validation errors:

• Required: Required field is missing
• Invalid: Provided field value is invalid
• Amout_Less_Than_Fee: Amount submitted is less than transaction fee
• Insufficient_Funds: Insufficient manager card balance for transaction
• ShareFunds_Failed: Unable to transfer funds due to an internal error

Authorizations

Header parameters

otpstringRequired

One time pass for the request

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

fromCardsIdinteger · int32Required

toCardsIdinteger · int32Required

amountnumber · doubleRequired

Responses

200

OK

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/customer/cards/movefunds HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
otp: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 42

{
  "fromCardsId": 1,
  "toCardsId": 1,
  "amount": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "status": "text",
  "errors": [
    {
      "errorType": "text",
      "fieldName": "text",
      "messageCode": "text"
    }
  ],
  "id": 1,
  "details": {
    "status": "text",
    "errors": [
      {
        "errorType": "text",
        "fieldName": "text",
        "messageCode": "text"
      }
    ],
    "id": 1,
    "details": {
      "customersId": 1,
      "customerReference": "text",
      "card": {
        "id": 1,
        "currency": "text",
        "cardNumber": "text",
        "totalBalance": 1,
        "availableBalance": 1,
        "pendingBalance": 1,
        "bSuppressed": true
      }
    }
  }
}

Example Request Body

{
  "fromCardsId": 1001,
  "toCardsId": 1002,
  "amount": 10
}