List Payout Methods

GET 
/affiliate-manager/:locationId/affiliate/:affiliateId/payout-method

List the payout methods stored for an affiliate. Bank account values are returned as their last four characters only.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

skip number

Possible values: >= 0 and <= 10000

Default value:0

limit number

Possible values: >= 1 and <= 100

Default value:10

application/json

Successful response

application/json

Schema

Schema

payoutMethodsobject[]required

Payout methods for the affiliate

metaobjectrequired

Pagination metadata

Example (auto)

{
  "payoutMethods": [
    {
      "_id": "63e35ac8b4dac93dfc2757c7",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "affiliateId": "6385d230f6d19db03eef6fb2",
      "method": "PAYPAL",
      "paypalEmail": "[email protected]",
      "bankDetails": {
        "bankCountry": "United States",
        "accountHolderName": "John Doe",
        "recipientAddress": {
          "country": "United States",
          "state": "California",
          "city": "San Francisco",
          "postalCode": "94105"
        },
        "fields": [
          {
            "key": "accountNumber",
            "value": "********5678"
          }
        ]
      },
      "isPrimary": true,
      "createdAt": "2024-06-16T00:00:00.000Z",
      "updatedAt": "2024-06-16T00:00:00.000Z"
    }
  ],
  "meta": {
    "count": 2
  }
}