Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Payout Methods

Retrieves payout methods in sorted (by epoch) order

Retrieves a list of the payout methods you've created for one of your sub accounts They are returned in sorted (by epoch) order (default is newest first)

get/accounts/{id}/payout-methods

Path parameters

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

the account id of one of your sub accounts

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the payout methods are returned. false will arrange the results with newest first whereas true shows oldest first

limitinteger
Example:10

Control how many items are return in a given page The max limit we allow is 25. The default is 10.

startsAfterstring
Example:pm_01FCTS1XMKH9FF43CAFA4CXT3P

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results.

Response

Successfully retrieved your payout methods

Example response

{
  "items": [
    {
      "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
    }
  ]
}