Create Payout Method

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

Store a payout method for an affiliate. An affiliate can hold one PayPal and one bank method; the first method stored becomes the primary one. Bank fields are validated against the requirements of the account country.

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

application/json

Body

Bodyrequired

paypalEmailstring

PayPal Email (required if method is PAYPAL)

payoutMethodstringrequired
Payout method to store the details under
Available optionsPAYPALBANK
bankDetailsobject

Bank Details (required if method is BANK)

Example (auto)

{
  "paypalEmail": "[email protected]",
  "payoutMethod": "PAYPAL",
  "bankDetails": {
    "bankCountry": "United States",
    "accountHolderName": "John Doe",
    "recipientAddress": {
      "country": "United States",
      "state": "California",
      "city": "San Francisco",
      "postalCode": "94105"
    },
    "fields": [
      {
        "key": "accountNumber",
        "value": "12345678"
      }
    ]
  }
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Payout method id

locationIdstringrequired

Location the payout method belongs to

affiliateIdstringrequired

Affiliate the payout method belongs to

methodstringrequired
Payout method type
Available optionsPAYPALBANK
paypalEmailstring

PayPal email, when the method is PAYPAL

bankDetailsobject

Bank details, when the method is BANK

isPrimarybooleanrequired

Whether payouts default to this method

createdAtstringrequired

Created at timestamp

updatedAtstringrequired

Updated at timestamp

Example (auto)

{
  "_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"
}