Payees

Update Payee Remote Id

Use v4 instead

Update the remote Id for the given Payee Id.

post/v3/payees/{payeeId}/remoteIdUpdate

Path parameters

payeeIdstring uuid required
Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9

The UUID of the payee.

Request body

payorIdstring uuid required
remoteIdstring required

Example request

{
  "payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e",
  "remoteId": "remoteId123"
}

Response

Accepted, No Content

Changes

Changed in 7 of the 50 revisions of this API.935

  • dd71433847a6530See the full diff
    • the errors/items/ response's property type/format changed from / to object/ for status 400

      response-property-type-changed

    • the errors/items/ response's property type/format changed from / to object/ for status 401

      response-property-type-changed

    • the errors/items/ response's property type/format changed from / to object/ for status 403

      response-property-type-changed

    • the errors/items/ response's property type/format changed from / to object/ for status 404

      response-property-type-changed

    • the errors/items/ response's property type/format changed from / to object/ for status 409

      response-property-type-changed

    • added the optional property errors/items/errorCode to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/errorCode to the response with the 401 status

      response-optional-property-added

    • added the optional property errors/items/errorCode to the response with the 403 status

      response-optional-property-added

    • added the optional property errors/items/errorCode to the response with the 404 status

      response-optional-property-added

    • added the optional property errors/items/errorCode to the response with the 409 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 401 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 403 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 404 status

      response-optional-property-added

    • added the optional property errors/items/errorData to the response with the 409 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 401 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 403 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 404 status

      response-optional-property-added

    • added the optional property errors/items/localisationDetails to the response with the 409 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 400 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 401 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 403 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 404 status

      response-optional-property-added

    • added the optional property httpStatusCode to the response with the 409 status

      response-optional-property-added

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/locationType deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    • response property errors/items/reasonCode deprecated

      response-property-deprecated

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint deprecated

      endpoint-deprecated

    • the response's body type/format changed from object/ to / for status 404

      response-body-type-changed

    • the errors/items/ response's property type/format changed from object/ to / for status 404

      response-property-type-changed

    This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7c8cfeb5995221See the full diff
    • the response's body type/format changed from object/ to / for status 409

      response-body-type-changed

    • the errors/items/ response's property type/format changed from object/ to / for status 409

      response-property-type-changed

    • api operation id updatePayeeRemoteIdV3 removed and replaced with

      api-operation-id-removed

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api operation id updatePayeeRemoteIdV3 was added

      api-operation-id-added

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed with deprecation

      api-path-removed-with-deprecation

    This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog