User

Create contact

Create a new contact for the current user.

post/api/v1/user/contact

Headers

x-api-keystring nullable

Request body

namestring

currencystring nullable

Currency override

emailstring nullable

How a payout contact relates to the user.

The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: SELF marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see SwipeluxRecipients._recipient_relationship — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.

Response

Successful Response

{"stackTrail":"paths:/api/v1/user/contact:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 4 revisions of this API.14436

Aug 27, 20267ed1b58c560714436See the full diff
- ▲
  removed app__schemas__base__ContactRelationship from the account/anyOf[subschema #1]/oneOf[subschema #3: SepaAccountInput]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the account/anyOf[subschema #1]/oneOf[subschema #5: AchAccountInput]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the account/anyOf[subschema #1]/oneOf[subschema #6: UaeAccountInput]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the iban/anyOf[subschema #1: IBANAccountDetails]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the iban/anyOf[subschema #2: USExternalAccountDetails]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed app__schemas__base__ContactRelationship from the iban/anyOf[subschema #3: SwiftAccountDetails]/relationship request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #1 from the account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/bankAddress request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #1 from the iban/anyOf[subschema #1: IBANAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #1 from the iban/anyOf[subschema #2: USExternalAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-removed
- ▲
  removed subschema #1 from the iban/anyOf[subschema #3: SwiftAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-removed
- ▲
  removed the enum value external of the request property relationship
  request-property-enum-value-removed
- ▲
  removed the enum value self of the request property relationship
  request-property-enum-value-removed
- ▲
  the relationship request property type/format changed from string/ to /
  request-property-type-changed
- ●
  removed the request property account/anyOf[subschema #1]/oneOf[subschema #3: SepaAccountInput]/country
  request-property-removed
- ●
  removed the request property account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/country
  request-property-removed
- ●
  removed the request property account/anyOf[subschema #1]/oneOf[subschema #5: AchAccountInput]/country
  request-property-removed
- ●
  removed the request property account/anyOf[subschema #1]/oneOf[subschema #6: UaeAccountInput]/accountHolderAddress
  request-property-removed
- ○
  added the new optional request property account/anyOf[subschema #1]/oneOf[subschema #3: SepaAccountInput]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property account/anyOf[subschema #1]/oneOf[subschema #5: AchAccountInput]/bankAddress
  new-optional-request-property
- ○
  added the new optional request property account/anyOf[subschema #1]/oneOf[subschema #5: AchAccountInput]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property account/anyOf[subschema #1]/oneOf[subschema #6: UaeAccountInput]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property iban/anyOf[subschema #1: IBANAccountDetails]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property iban/anyOf[subschema #2: USExternalAccountDetails]/businessIndustry
  new-optional-request-property
- ○
  added the new optional request property iban/anyOf[subschema #2: USExternalAccountDetails]/us/bic
  new-optional-request-property
- ○
  added the new optional request property iban/anyOf[subschema #3: SwiftAccountDetails]/businessIndustry
  new-optional-request-property
- ○
  added BankAddressDetails to the iban/anyOf[subschema #1: IBANAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-added
- ○
  added BankAddressDetails to the iban/anyOf[subschema #2: USExternalAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-added
- ○
  added BankAddressDetails to the iban/anyOf[subschema #3: SwiftAccountDetails]/bankAddress request property anyOf list
  request-property-any-of-added
- ○
  added BankAddressInput to the account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/bankAddress request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the account/anyOf[subschema #1]/oneOf[subschema #3: SepaAccountInput]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the account/anyOf[subschema #1]/oneOf[subschema #4: SwiftAccountInput]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the account/anyOf[subschema #1]/oneOf[subschema #5: AchAccountInput]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the account/anyOf[subschema #1]/oneOf[subschema #6: UaeAccountInput]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the iban/anyOf[subschema #1: IBANAccountDetails]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the iban/anyOf[subschema #2: USExternalAccountDetails]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship to the iban/anyOf[subschema #3: SwiftAccountDetails]/relationship request property anyOf list
  request-property-any-of-added
- ○
  added ContactRelationship subschema #2 to the relationship request property anyOf list
  request-property-any-of-added
- ○
  added PixAccountDetails-Input LocalRailAccountDetails-Input ProviderUsdAccountDetails-Input to the iban request property anyOf list
  request-property-any-of-added
- ○
  the request property iban/anyOf[subschema #1: IBANAccountDetails]/ibanNumber became optional
  request-property-became-optional
- ○
  the request property iban/anyOf[subschema #2: USExternalAccountDetails]/us/accountNumber became optional
  request-property-became-optional
- ○
  the request property iban/anyOf[subschema #2: USExternalAccountDetails]/us/routingNumber became optional
  request-property-became-optional
- ○
  the request property iban/anyOf[subschema #3: SwiftAccountDetails]/swift/accountNumber became optional
  request-property-became-optional
- ○
  the request property iban/anyOf[subschema #3: SwiftAccountDetails]/swift/bic became optional
  request-property-became-optional
- ○
  the relationship request property default value external was removed
  request-property-default-value-removed
- ○
  the relationship request property default value resident_transfer_between_accounts was removed
  request-property-default-value-removed
- ○
  added discriminator to account/anyOf[subschema #1]/ request property
  request-property-discriminator-added
- ○
  request property iban/anyOf[subschema #1: IBANAccountDetails]/ibanNumber list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property iban/anyOf[subschema #2: USExternalAccountDetails]/us/accountNumber list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property iban/anyOf[subschema #2: USExternalAccountDetails]/us/routingNumber list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property iban/anyOf[subschema #3: SwiftAccountDetails]/swift/accountNumber list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property iban/anyOf[subschema #3: SwiftAccountDetails]/swift/bic list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added UkFpsAccountInput PixAccountInput to the account/anyOf[subschema #1]/ request property oneOf list
  request-property-one-of-added
This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history