Update Recipient

Update the given recipient

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

recipientId*string

Query Parameters

accountNumber?string

Client account number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Inherits Recipient

This is a composite request. It is used when you need to update a recipient.

entity*

A recipient entity used to represent either a consumer or company

payoutMethod*

Payout Method object represent your recipient's payout instrument. This object can be used in combination with registering recipients or as part of a collection of payments.

currency*string

Response Body

`application/json`

curl -X PUT "https://example.com/v2/recipients/string" \  -H "Content-Type: application/json" \  -d '{    "entity": {      "type": "Company"    },    "payoutMethod": {      "type": "BankAccount"    },    "currency": "string"  }'

{  "entity": {    "company": {      "address": {        "country": "GB",        "line1": "1 Apartment name",        "line2": "Railway Terrace",        "locality": "Slough",        "postcode": "string",        "region": "Berkshire,QLD,TX"      },      "emailAddress": "string",      "idNumber": "string",      "idType": "string",      "industryTypeCode": "string",      "name": "string",      "phoneNumber": "string",      "taxNumber": "string"    },    "consumer": {      "address": {        "country": "GB",        "line1": "1 Apartment name",        "line2": "Railway Terrace",        "locality": "Slough",        "postcode": "string",        "region": "Berkshire,QLD,TX"      },      "emailAddress": "string",      "familyName": "string",      "givenNames": "string",      "idNumber": "string",      "idType": "string",      "mobileNumber": "string",      "phoneNumber": "string",      "taxNumber": "string",      "title": "string"    },    "isDeactivated": false,    "type": "Company"  },  "payoutMethod": {    "bank": {      "account": {        "accountName": "ACME",        "accountNumber": "12345674",        "accountType": "string",        "bic": "MIDLGB22XXX",        "branchNumber": "string",        "country": "GB",        "iban": "GB26MIDL40051512345674",        "ncc": "string"      },      "intermAccount": {        "accountName": "ACME",        "accountNumber": "12345674",        "bic": "MIDLGB22XXX",        "country": "GB",        "iban": "GB26MIDL40051512345674",        "ncc": "string"      }    },    "type": "BankAccount"  },  "currency": "string",  "recipientId": {    "clientReference": "ACMER1284",    "xeRecipientId": "124863"  }}

{  "code": 0,  "failureDateTime": "2019-08-24T14:15:22Z",  "longErrorMsg": "string",  "shortErrorMsg": "string",  "traceErrorId": "string",  "typeOfFailure": "MODEL_VALIDATION"}

Empty