Skip to main content
Payout MethodsVersion: v3

Update Payout Method

PUT/affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}

Replace the stored details of a payout method. The payout method type cannot be changed, and the method must belong to the affiliate named in the path.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
affiliateIdstringrequired

Affiliate Id

Example:63e35ac8b4dac93dfc2757c7
payoutMethodIdstringrequired

Payout Method Id

Example:63e35ac8b4dac93dfc2757c7

Body

application/json
paypalEmailstring

PayPal Email (required if method is PAYPAL)

Example:[email protected]
payoutMethodstringrequired

Payout method to store the details under

Available optionsPAYPALBANK
Example:PAYPAL
bankDetailsobject

Bank Details (required if method is BANK)

Response

application/json

Successful response

_idstringrequired

Payout method id

Example:63e35ac8b4dac93dfc2757c7
locationIdstringrequired

Location the payout method belongs to

Example:ve9EPM428h8vShlRW1KT
affiliateIdstringrequired

Affiliate the payout method belongs to

Example:6385d230f6d19db03eef6fb2
methodstringrequired

Payout method type

Available optionsPAYPALBANK
Example:PAYPAL
paypalEmailstring

PayPal email, when the method is PAYPAL

Example:[email protected]
bankDetailsobject

Bank details, when the method is BANK

isPrimarybooleanrequired

Whether payouts default to this method

Example:true
createdAtstringrequired

Created at timestamp

Example:2024-06-16T00:00:00.000Z
updatedAtstringrequired

Updated at timestamp

Example:2024-06-16T00:00:00.000Z