Update

PATCH 
/transfer-consents/:id

Update the status of TransferConsent.

Request

Path Parameters

id uuidrequired

application/json

Body

required

The partial of TransferConsent, only containing the fields that should be updated.

transfer_consent

object

Partial Transfer consent, only containing the fields that should be updated. The status of savehack launch can be changed by setting the consentedAt and rejectedAt timestamps respectively.

consentedAt RFC3339

rejectedAt RFC3339

Responses

200

Request was successful

application/json

Schema

Schema

transferConsent

object

id uuidrequired

maxFrequency stringrequired

Possible values: [once day week month year]

maxAmountCents numberrequired

savehackLaunchId uuidrequired

obsoleteSavehackLaunchId uuid

user

object

type stringrequired

id stringrequired

externalId string

Example (from schema)

{
  "transferConsent": {
    "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
    "maxFrequency": "once",
    "maxAmountCents": 1012,
    "savehackLaunchId": "916430a8-b845-4cbc-b79f-865cd8c83mw1",
    "obsoleteSavehackLaunchId": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
    "user": {
      "type": "user",
      "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
      "externalId": "10002345"
    }
  }
}

400

Bad request.

application/json

Schema

Schema

errors

object[]

required

Array [

field stringrequired

errors string[]required

]

Example (from schema)

{
  "errors": [
    {
      "field": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

Example

{
  "errors": [
    {
      "field": "transfer_consent.consented_at",
      "errors": [
        "consented_at and rejected_at are mutually exclusive"
      ]
    },
    {
      "field": "transfer_consent.rejected_at",
      "errors": [
        "consented_at and rejected_at are mutually exclusive"
      ]
    }
  ]
}

Loading...