Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Payout Methods

Update a payout method by Id

This is used to update an existing payout method for one of your sub accounts

patch/accounts/{id}/payout-methods/{payoutMethodId}

Path parameters

idstring required
Example:ac_b83f2653-06d7-44a9-a548-5825e8186004

the account id of one of your sub accounts

payoutMethodIdstring required
Example:pm_01FCTS1XMKH9FF43CAFA4CXT3P

Payout method to retrieve

Request body

displayNamestring nullable

A friendly name for the payout method, for display only

Example request

{
  "displayName": "Primary GBP Account",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0230",
    "branchIdType": "TransitNumber",
    "branchId": "11122",
    "swiftCode": "NAIAGB21",
    "accountNumberType": "UnitedKingdom",
    "accountNumber": "082100",
    "address": {
      "lineOne": "123 Test Street",
      "city": "Manchester",
      "country": "GB",
      "postalCode": "SP4 7DE"
    }
  }
}

Response

Successfully updated the given payout method

idstring

The id of the payout method

type'BankAccount'
displayNamestring nullable

A friendly name for the payout method, for display only

status'Invalid' | 'Valid'
invalidReasonstring nullable

The reason why the payout method has been marked as 'Invalid'

currencystring

The three-character ISO 4217 currency code of the payout method

countryCodestring

The two-character ISO 3166 country code of the payout method

createdTimestampinteger

The epoch timestamp (seconds) when the payout method was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the payout method was last updated

Example response

{
  "id": "pm_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "type": "BankAccount",
  "displayName": "Primary GBP Account",
  "status": "Valid",
  "currency": "GBP",
  "countryCode": "GB",
  "bankAccount": {
    "bankIdType": "SortCode",
    "bankId": "0123",
    "branchIdType": "TransitNumber",
    "branchId": "11122",
    "bankName": "Ryft Bank Ltd",
    "swiftCode": "NAIAGB21",
    "accountNumberType": "UnitedKingdom",
    "last4": "0001",
    "address": {
      "lineOne": "123 Test Street",
      "city": "Manchester",
      "country": "GB",
      "postalCode": "SP4 7DE"
    }
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}