Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
payout-destinations

oid_mgmnt_payout_destinations_by_id_patch

Update a payout destination. Currently only allows update of payout_interval_type.

scopes:

  • admin:accounts
  • write:accounts
patch/accounts/{oid}/payout-destinations/{payout_destination_id}

Path parameters

oidstring ^[PT]{1}(?=(?:.{3}|.{8})$)[0-9]*$ required

An id that uniquely identifies the account or owner (partner)

payout_destination_idstring required

The payout destination identifier

Request body

payout_interval_type'day' | 'week' | 'month' | 'manual'

Response

Payout destination

idstring uuid required

An UUID that uniquely identifies the resource

created_atstring date-time required

The date-time when the resource was created

created_bystring required

The ID of the user/client created the resource

updated_atstring date-time required

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
payout_destination_idstring
updated_bystring required
account_idstring required
case_status'ACTIVE' | 'DECLINED' | 'UNDER_MANUAL_REVIEW' | 'AUTOMATIC_REVIEW' | 'WAITING_FOR_SIGNATURE' | 'WAITING_FOR_DECLARATION' | 'ERROR' | 'ARCHIVED' | 'WAITING_FOR_DETAILS' | 'TERMINATED' required
type'company' | 'individual' required

Type of legal entity

merchant_category_codestring mcc
payout_interval_type'day' | 'week' | 'month' | 'manual'
payout_referencestring

Reference on transfers in bank statements

emailstring email
websitestring uri
phone_numberstring

ITU/E.123 format with international prefix (+PPNNNNNNNNN...)

payout_destination_namestring

The name of the payout destination

payout_destination_descriptionstring

Description of the payout destination

number_of_storesinteger

Number of stores associated with the payout destination

number_of_terminalsinteger

Number of terminals associated with the payout destination

Example response

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "payout_destination_id": "PD032",
  "merchant_category_code": "2741",
  "individual": {
    "address_line": "Sommerkroveien 34",
    "address_line_2": "PB 123",
    "address_postal_code": "0349",
    "address_city": "Oslo",
    "address_country": "NO"
  },
  "address": {
    "address_line": "Sommerkroveien 34",
    "address_line_2": "PB 123",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO"
  },
  "bank_accounts": [
    {
      "bank_account_country_code": "NO",
      "bank_account_currency": "NOK",
      "bank_identification_code": "DNBANOKKXXX"
    }
  ],
  "terminals": [
    {
      "terminal_id": "T312",
      "device_serial_number": "181f1a3e-b81b-4460-a01b-2a3be2a253a1"
    }
  ],
  "stores": [
    {
      "store_id": "S1",
      "store_name": "Store 1",
      "address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO"
      },
      "number_of_terminals": 10
    }
  ]
}