Skip to content

Latest commit

 

History

History
232 lines (186 loc) · 7.8 KB

balances.md

File metadata and controls

232 lines (186 loc) · 7.8 KB
Raw

Balances

Balance-related operations

$balancesController = $client->getBalancesController();

Class Name

BalancesController

Methods

List User Balances

Retrieve a list of user balances that supports filtering, sorting, and pagination through existing mechanisms.

function listUserBalances(
    string $userToken,
    string $xMyPayQuickerVersion,
    ?int $page = null,
    ?int $pageSize = 20,
    ?string $filter = null,
    ?string $sort = null,
    ?string $language = null
): BalanceCollectionResponse

Parameters

Parameter Type Tags Description
userToken string Template, Required Auto-generated unique identifier representing a user, prefixed with user-.
xMyPayQuickerVersion string Header, Required Date-based API Version specified in the header required on all calls.
page ?int Query, Optional Page number of specific page to return
Constraints: >= 1
pageSize ?int Query, Optional Number of items to be displayed per page
Default: 20
Constraints: >= 1, <= 50
filter ?string Query, Optional Filter request results by specific criteria.
sort ?string Query, Optional Sort request results by specific attribute.
language ?string (LanguageTypesEnum) Query, Optional Filter results by language type.

Response Type

BalanceCollectionResponse

Example Usage

$userToken = 'user-f012bc86-4d42-415b-a8b2-be5e0b90e59a';
$xMyPayQuickerVersion = '2020.02.24';
$pageSize = 20;
$filter = '\'name\'*\'Fra\'||*\'Ger\',\'numericCode\'>\'5\'';
$sort = '-name';
$language = Models\LanguageTypesEnum::ENUS;

$result = $balancesController->listUserBalances($userToken, $xMyPayQuickerVersion, null, $pageSize, $filter, $sort, $language);

Example Response (as JSON)

{
  "payload": [
    {
      "formattedAmount": "$4.32 USD",
      "amount": 4.32,
      "currency": "USD",
      "token": "dest-4aed86e2-4929-45bf-814d-9030aef21e79",
      "links": [
        {
          "params": {
            "rel": "self"
          },
          "href": "https://platform.mypayquicker.com/api/v2/users/user-f012bc86-4d42-415b-a8b2-be5e0b90e59a/prepaid-cards/dest-4aed86e2-4929-45bf-814d-9030aef21e79/balances"
        }
      ]
    }
  ],
  "links": [
    {
      "params": {
        "rel": "self"
      },
      "href": "https://platform.mypayquicker.com/api/v2/users/user-f012bc86-4d42-415b-a8b2-be5e0b90e59a/balances"
    }
  ]
}

List Prepaid Card Balance

Retrieve a list of balances by destination token that supports filtering, sorting, and pagination through existing mechanisms. *If the user belongs to a Flex-based program, balances against the user resource will return the wallet balance only. If it is a pre-paid card program (i.e., Meta USD), this balance and its associated pre-paid card balance will be the same.

function listPrepaidCardBalance(
    string $userToken,
    string $destToken,
    string $xMyPayQuickerVersion,
    ?int $page = null,
    ?int $pageSize = 20,
    ?string $filter = null,
    ?string $sort = null,
    ?string $language = null
): BalanceCollectionResponse

Parameters

Parameter Type Tags Description
userToken string Template, Required Auto-generated unique identifier representing a user, prefixed with user-.
destToken string Template, Required Auto-generated unique identifier representing a transfer destination, including prepaid cards, bank accounts, paper checks, and other users, prefixed with dest->.
Constraints: Pattern: ^dest-[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$
xMyPayQuickerVersion string Header, Required Date-based API Version specified in the header required on all calls.
page ?int Query, Optional Page number of specific page to return
Constraints: >= 1
pageSize ?int Query, Optional Number of items to be displayed per page
Default: 20
Constraints: >= 1, <= 50
filter ?string Query, Optional Filter request results by specific criteria.
sort ?string Query, Optional Sort request results by specific attribute.
language ?string (LanguageTypesEnum) Query, Optional Filter results by language type.

Response Type

BalanceCollectionResponse

Example Usage

$userToken = 'user-f012bc86-4d42-415b-a8b2-be5e0b90e59a';
$destToken = 'dest-4aed86e2-4929-45bf-814d-9030aef21e79';
$xMyPayQuickerVersion = '2020.02.24';
$pageSize = 20;
$filter = '\'name\'*\'Fra\'||*\'Ger\',\'numericCode\'>\'5\'';
$sort = '-name';
$language = Models\LanguageTypesEnum::ENUS;

$result = $balancesController->listPrepaidCardBalance($userToken, $destToken, $xMyPayQuickerVersion, null, $pageSize, $filter, $sort, $language);

Example Response (as JSON)

{
  "formattedAmount": "$4.32",
  "amount": 4.32,
  "currency": "USD",
  "token": "dest-4aed86e2-4929-45bf-814d-9030aef21e79",
  "links": [
    {
      "params": {
        "rel": "self"
      },
      "href": "https://platform.mypayquicker.com/api/v2/users/user-f012bc86-4d42-415b-a8b2-be5e0b90e59a/prepaid-cards/dest-4aed86e2-4929-45bf-814d-9030aef21e79/balances"
    }
  ]
}

List Account Balances

Retrieve a single account balance.

function listAccountBalances(
    string $acctToken,
    string $xMyPayQuickerVersion,
    ?int $page = null,
    ?int $pageSize = 20,
    ?string $filter = null,
    ?string $sort = null,
    ?string $language = null
): BalanceCollectionResponse

Parameters

Parameter Type Tags Description
acctToken string Template, Required Auto-generated unique identifier representing a company account, prefixed with acct-.
xMyPayQuickerVersion string Header, Required Date-based API Version specified in the header required on all calls.
page ?int Query, Optional Page number of specific page to return
Constraints: >= 1
pageSize ?int Query, Optional Number of items to be displayed per page
Default: 20
Constraints: >= 1, <= 50
filter ?string Query, Optional Filter request results by specific criteria.
sort ?string Query, Optional Sort request results by specific attribute.
language ?string (LanguageTypesEnum) Query, Optional Filter results by language type.

Response Type

BalanceCollectionResponse

Example Usage

$acctToken = 'acct-b3f0570a-6586-4e00-8d6e-8a2bf93cfae4';
$xMyPayQuickerVersion = '2020.02.24';
$pageSize = 20;
$filter = '\'name\'*\'Fra\'||*\'Ger\',\'numericCode\'>\'5\'';
$sort = '-name';
$language = Models\LanguageTypesEnum::ENUS;

$result = $balancesController->listAccountBalances($acctToken, $xMyPayQuickerVersion, null, $pageSize, $filter, $sort, $language);

Example Response (as JSON)

{
  "payload": [
    {
      "formattedAmount": "$5.00",
      "amount": 5,
      "currency": "USD",
      "token": "acct-b3f0570a-6586-4e00-8d6e-8a2bf93cfae4"
    }
  ],
  "links": [
    {
      "params": {
        "rel": "self"
      },
      "href": "https://platform.mypayquicker.com/api/v2/accounts/acct-b3f0570a-6586-4e00-8d6e-8a2bf93cfae4/balances"
    }
  ]
}