Skip to main content
GET
/
brokerage-firms
/
{brokerageFirmId}
/
payment-methods
Get Payment Methods
curl --request GET \
  --url https://api.example.com/brokerage-firms/{brokerageFirmId}/payment-methods
{
  "data": [
    {
      "metadata": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "type": "<string>",
      "id": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "paymentMethodType": "card",
      "mandateDocumentId": "<string>",
      "last4": "<string>",
      "expirationMonth": 123,
      "expirationYear": 123,
      "billingDetails": {
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "address": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "postalCode": "<string>",
          "state": "<string>"
        }
      }
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

Response

Payment methods retrieved successfully.

data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages