Get Customer Cards

Get Customer Cards

List cards for all managed customers

• Endpoint: /api/v1/customer/cards/byuser/list

• Method: GET

Get all customers

get

Response:

Array of

• Id: Customer Id
• Reference: Customer reference used when creating customer
• Cards: Array of cards owned by the customer
  • Id: Card Id
  • Currency: Card currency
  • TotalBalance: Card total balance
  • AvailableBalance: Available card balance
  • PendingBalance: Sum of all pending transaction amounts
  • bSuppressed: boolean indicating whether a card is deactivated

Authorizations

Query parameters

PageNumberinteger · int32Optional

PageSizeinteger · int32Optional

Header parameters

otpstringRequired

One time pass for the request

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customer/cards/byuser/list HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
otp: text
Accept: */*

{
  "status": "text",
  "errors": [
    {
      "errorType": "text",
      "fieldName": "text",
      "messageCode": "text"
    }
  ],
  "id": 1,
  "details": [
    {
      "customersId": 1,
      "customersReference": "text",
      "cards": [
        {
          "id": 1,
          "currency": "text",
          "cardNumber": "text",
          "totalBalance": 1,
          "availableBalance": 1,
          "pendingBalance": 1,
          "bSuppressed": true
        }
      ]
    }
  ],
  "pageSize": 1,
  "pageNumber": 1,
  "numberOfPages": 1
}

Query Parameters:

• pageNumber (Integer, Optional): The page of results to return.

• pageSize (Integer, Optional): The maximum number of results to return per page.

---

Get Cards By Customer

The "Get Customer Cards" feature is a way for users to view all the cards and card details associated with their customers. This list provides essential information such as the card's balance, pending transactions, and whether the card is currently active or disabled. This is particularly helpful for keeping an overview of all customer activity and ensuring that their cards are properly managed.

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

• Method: GET

Get single customer

get

Request query parameters:

• CustomersId: Customer Id

Response:

• CustomersId: Customer Id
• CustomersReference: Customer reference used when creating customer
• Cards: Array of cards owned by the customer
  • Id: Card Id
  • Currency: Card currency
  • TotalBalance: Card total balance
  • AvailableBalance: Available card balance
  • PendingBalance: Sum of all pending transaction amounts
  • bSuppressed: boolean indicating whether a card is deactivated

Possible validation errors:

• Required: Customer Id missing
• Invalid: Customer Id invalid

Authorizations

Query parameters

CustomersIdinteger · int32 | nullableOptional

Header parameters

otpstringRequired

One time pass for the request

Responses

200

Success

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customer/cards/byuser HTTP/1.1
Host: public-api.ibanera.com
Authorization: YOUR_API_KEY
otp: text
Accept: */*

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

Query Parameters:

• customersId(Integer, Optional): The customer's ID for which the card details will be retrieved.

Request Example:

To request the list of managed cards using pagination:

GET /api/v1/customer/cards/byuser?customersId=11057

Response Body Parameters:

• id (Integer): Not used.

• details (Array of Objects):

  • customersId (Integer): ID of the customer.

  • customersReference (String): The customer reference used when creating the customer.

  • cards (Array of Objects):

    • id (Integer): ID of the customer's card.

    • currency (String): Currency of the card.

    • totalBalance (Decimal): Total balance on the card.

    • availableBalance (Decimal): The available balance on the card.

    • pendingBalance (Decimal): Sum of all pending transaction amounts.

    • bSuppressed (Boolean): True if use of this card is disabled.

Success Response Example:

{
  "id": 0,
  "details": [
    {
      "customersId": 0,
      "customersReference": "string",
      "cards": [
        {
          "id": 0,
          "currency": "usd",
          "totalBalance": 0,
          "availableBalance": 0,
          "pendingBalance": 0,
          "bSuppressed": true
        }
      ]
    }
  ],
  "pageSize": 10,
  "pageNumber": 1,
  "status": "1",
  "errors": []
}