Skip to content

Commit 0cc7241

Browse files
author
Nicki Nixon
committed
update member create description, add 201 response sample with error object
1 parent c82b864 commit 0cc7241

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

openapi/v20250224.yml

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1509,7 +1509,7 @@ paths:
15091509
tags:
15101510
- members
15111511
post:
1512-
description: This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
1512+
description: This endpoint allows you to create a new member using the required parameters `institution_code`, `credentials` (if creating a non-OAuth member), and `data_request.products`. When creating a non-OAuth member, include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. A status of 200 indicates the member was created successfully, and no aggregation was requested. A status of 201 indicates the member was created, but a product within `data_request` failed to aggregate. A status of 202 indicates the member was successfully created, and standard aggregation (no `data_request`) was requested (does not indicate success or failure).
15131513
operationId: createMember
15141514
parameters:
15151515
- $ref: '#/components/parameters/acceptVersion'
@@ -1529,6 +1529,12 @@ paths:
15291529
schema:
15301530
$ref: '#/components/schemas/MemberResponseBody'
15311531
description: OK
1532+
'201':
1533+
content:
1534+
application/json:
1535+
schema:
1536+
$ref: '#/components/schemas/MemberResponseWithJobErrorBody'
1537+
description: Created
15321538
'202':
15331539
content:
15341540
application/json:
@@ -6770,6 +6776,29 @@ components:
67706776
nullable: true
67716777
type: string
67726778
type: object
6779+
MemberResponseWithJobError:
6780+
allOf:
6781+
- $ref: '#/components/schemas/MemberResponse'
6782+
- type: object
6783+
properties:
6784+
error:
6785+
type: object
6786+
properties:
6787+
error_type:
6788+
type: string
6789+
example: "MEMBER"
6790+
error_code:
6791+
type: integer
6792+
example: 3003
6793+
error_message:
6794+
type: string
6795+
example: "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request."
6796+
user_message:
6797+
type: string
6798+
example: "We're having trouble connecting right now. Please try again later."
6799+
locale:
6800+
type: string
6801+
example: "en"
67736802
MembersResponseBody:
67746803
properties:
67756804
members:
@@ -6810,6 +6839,11 @@ components:
68106839
member:
68116840
$ref: '#/components/schemas/MemberResponse'
68126841
type: object
6842+
MemberResponseWithJobErrorBody:
6843+
properties:
6844+
member:
6845+
$ref: '#/components/schemas/MemberResponseWithJobError'
6846+
type: object
68136847
ManagedMemberUpdateRequest:
68146848
properties:
68156849
id:

0 commit comments

Comments
 (0)