diff --git a/openapi/mx_platform_api.yml b/openapi/mx_platform_api.yml index 86ce6eb..438d248 100644 --- a/openapi/mx_platform_api.yml +++ b/openapi/mx_platform_api.yml @@ -1556,6 +1556,86 @@ components: example: 1 type: integer type: object + PaymentAccountResponse: + properties: + account_name: + example: My Savings + nullable: true + type: string + account_number: + example: '1858091489' + nullable: true + type: string + account_type: + example: SAVINGS + nullable: true + type: string + available_balance: + example: 1000.0 + nullable: true + type: number + balance: + example: 1000.0 + nullable: true + type: number + routing_number: + example: '68899990000000' + nullable: true + type: string + transit_number: + example: '12345' + nullable: true + type: string + type: object + PaymentAccountResponseBody: + properties: + payment_account: + "$ref": "#/components/schemas/PaymentAccountResponse" + type: object + PaymentProcessorAuthorizationCodeRequest: + properties: + account_guid: + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + type: string + member_guid: + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + type: string + user_guid: + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + type: string + type: object + PaymentProcessorAuthorizationCodeRequestBody: + properties: + payment_processor_authorization_code: + "$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequest" + type: object + PaymentProcessorAuthorizationCodeResponse: + properties: + authorization_code: + example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM + nullable: true + type: string + type: object + PaymentProcessorAuthorizationCodeResponseBody: + properties: + payment_processor_authorization_code: + "$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponse" + type: object + PaymentProcessorTokenResponseBody: + properties: + access_token: + example: jUmJS4AZVdvywAMO_JWKwZ8fvY9ZZQINSBHTKkHMw-c + nullable: true + type: string + scope: + example: payment_accounts + nullable: true + type: string + token_type: + example: bearer + nullable: true + type: string + type: object StatementResponse: properties: account_guid: @@ -2161,6 +2241,9 @@ components: basicAuth: scheme: basic type: http + bearerAuth: + scheme: bearer + type: http info: contact: name: MX Platform API @@ -2473,6 +2556,72 @@ paths: summary: Read merchant tags: - mx_platform + "/payment_account": + get: + description: Use this endpoint to request a payment account. + operationId: requestPaymentAccount + responses: + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/PaymentAccountResponseBody" + description: OK + security: + - bearerAuth: [] + summary: Request payment account + tags: + - mx_platform + "/payment_processor_authorization_code": + post: + description: Use this endpoint to request a payment processor authorization + code. + operationId: requestPaymentProcessorAuthorizationCode + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequestBody" + description: Payment processor authorization code object containing account_guid, + member_guid, and user_guid. + required: true + responses: + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponseBody" + description: OK + summary: Request payment processor authorization code + tags: + - mx_platform + "/payment_processor_token": + post: + description: Use this endpoint to request a payment processor token. + operationId: requestPaymentProcessorToken + parameters: + - description: Code to request processor token. + example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM + in: query + name: code + schema: + type: string + - description: Specify grant type. + example: authorization_code + in: query + name: grant_type + schema: + type: string + responses: + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/PaymentProcessorTokenResponseBody" + description: OK + summary: Request payment processor token + tags: + - mx_platform "/transactions/enhance": post: description: Use this endpoint to categorize, cleanse, and classify transactions.