Disclaimer banner cps-icon-v2

This documentation applies to the Legacy platform. If your dashboard matches the screenshot shown here, please refer to the new platform documentation.

Disclaimer banner image
New documentation
Disclaimer banner image

Get $PayByName Tag List

API POST Fields (in addition to the Main Fields described in the Introduction)

Field Name
Get $PayByName Tag List
cmd
Descriptionget_pbn_list
Required?Yes
Field NameDescriptionRequired?
Get $PayByName Tag List
cmdget_pbn_listYes

API Response

A successful call to this command will give you a result similar to this (JSON):
{  
   "error":"ok",
   "result":[  
      {  
         "tagid":"e893b55c2216a20e6761b1a9f32409df",
         "pbntag":"Test1",
         "time_expires":2147483647
      },
      {  
         "tagid":"4293b55c2216a20e6761b1a9f32409de",
         "pbntag":"Test2",
         "time_expires":2147483647
      },
      {  
         "tagid":"35df17c48fc16cff8dcee35cedd42d2d",
         "pbntag":"",
         "time_expires":1497037845
      }
   ]
}
The result wil have the following fields:
  • tagid = This is the unique identifier of the tag in the system. This is the identifier you will use with the 'update_pbn_tag' and 'claim_pbn_tag' API calls.
  • pbntag = This is the $PayByName tag. An empty string means the tag is unclaimed. (Note that the tags do not have a $ at the front.)
  • time_expires = The time (Unix timestamp) of when the tag expires.