Update payee

put

https://sandbox-api-v2.dogpay.com/open-api/v1/payout/payee

Updates the information of an existing payee record. The payee ID must be provided in the request body to identify the record.

👉 Payout Validation Rules

👉 Payout And Remittance Guide

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

currency

string

enum

required

Payee currency

country

string

enum

required

Opening Bank Country

firstName

string

First Name. Max length: 35 characters. Must contain only ASCII letters and spaces.

lastName

string

required

Last Name / Company Name. Max length: 35 characters. Must contain only ASCII letters and spaces.

accountNumber

string

required

Bank Account Number. Max length: 35 characters. Must contain only ASCII letters, numbers, spaces, and hyphens.

bankName

string

required

Bank Name. Max length: 35 characters. Must have alphanumeric boundaries, allowing spaces and (- ' & . , ( ) /) in the middle.

bankCode

string

required

Bank Code. Required if receiveType is local. Max length: 20 characters. Must contain only half-width letters or numbers.

bankAddress

object

Bank Address. Optional. Omitting this field during update will clear the existing bank address in the database.

bicSwift

string

required

BIC/Swift Code. Required if receiveType is swift. Length must be exactly 8 or 11 characters. Must contain only half-width letters or numbers.

payeeAddress

object

required

Beneficiary Address. Required. Must pass the nested strict address validation rules.

label

string

Label/Note

sortCode

string

SortCode, UK only

string

required

Payee ID

Headers

dgp-entity-id

string

The unique identifier of the target entity. Mandatory for white-label customers to define the sub-entity context.

Response

200