Skip to content

Commit 11b47db

Browse files
Merge pull request #68 from mxenabled/bm/add_partner_token_endpoints
Adds partner token endpoints
2 parents c38dbd8 + 9a11a61 commit 11b47db

1 file changed

Lines changed: 149 additions & 0 deletions

File tree

openapi/mx_platform_api.yml

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1556,6 +1556,86 @@ components:
15561556
example: 1
15571557
type: integer
15581558
type: object
1559+
PaymentAccountResponse:
1560+
properties:
1561+
account_name:
1562+
example: My Savings
1563+
nullable: true
1564+
type: string
1565+
account_number:
1566+
example: '1858091489'
1567+
nullable: true
1568+
type: string
1569+
account_type:
1570+
example: SAVINGS
1571+
nullable: true
1572+
type: string
1573+
available_balance:
1574+
example: 1000.0
1575+
nullable: true
1576+
type: number
1577+
balance:
1578+
example: 1000.0
1579+
nullable: true
1580+
type: number
1581+
routing_number:
1582+
example: '68899990000000'
1583+
nullable: true
1584+
type: string
1585+
transit_number:
1586+
example: '12345'
1587+
nullable: true
1588+
type: string
1589+
type: object
1590+
PaymentAccountResponseBody:
1591+
properties:
1592+
payment_account:
1593+
"$ref": "#/components/schemas/PaymentAccountResponse"
1594+
type: object
1595+
PaymentProcessorAuthorizationCodeRequest:
1596+
properties:
1597+
account_guid:
1598+
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
1599+
type: string
1600+
member_guid:
1601+
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
1602+
type: string
1603+
user_guid:
1604+
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
1605+
type: string
1606+
type: object
1607+
PaymentProcessorAuthorizationCodeRequestBody:
1608+
properties:
1609+
payment_processor_authorization_code:
1610+
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequest"
1611+
type: object
1612+
PaymentProcessorAuthorizationCodeResponse:
1613+
properties:
1614+
authorization_code:
1615+
example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
1616+
nullable: true
1617+
type: string
1618+
type: object
1619+
PaymentProcessorAuthorizationCodeResponseBody:
1620+
properties:
1621+
payment_processor_authorization_code:
1622+
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponse"
1623+
type: object
1624+
PaymentProcessorTokenResponseBody:
1625+
properties:
1626+
access_token:
1627+
example: jUmJS4AZVdvywAMO_JWKwZ8fvY9ZZQINSBHTKkHMw-c
1628+
nullable: true
1629+
type: string
1630+
scope:
1631+
example: payment_accounts
1632+
nullable: true
1633+
type: string
1634+
token_type:
1635+
example: bearer
1636+
nullable: true
1637+
type: string
1638+
type: object
15591639
StatementResponse:
15601640
properties:
15611641
account_guid:
@@ -2161,6 +2241,9 @@ components:
21612241
basicAuth:
21622242
scheme: basic
21632243
type: http
2244+
bearerAuth:
2245+
scheme: bearer
2246+
type: http
21642247
info:
21652248
contact:
21662249
name: MX Platform API
@@ -2473,6 +2556,72 @@ paths:
24732556
summary: Read merchant
24742557
tags:
24752558
- mx_platform
2559+
"/payment_account":
2560+
get:
2561+
description: Use this endpoint to request a payment account.
2562+
operationId: requestPaymentAccount
2563+
responses:
2564+
'200':
2565+
content:
2566+
application/vnd.mx.api.v1+json:
2567+
schema:
2568+
"$ref": "#/components/schemas/PaymentAccountResponseBody"
2569+
description: OK
2570+
security:
2571+
- bearerAuth: []
2572+
summary: Request payment account
2573+
tags:
2574+
- mx_platform
2575+
"/payment_processor_authorization_code":
2576+
post:
2577+
description: Use this endpoint to request a payment processor authorization
2578+
code.
2579+
operationId: requestPaymentProcessorAuthorizationCode
2580+
requestBody:
2581+
content:
2582+
application/json:
2583+
schema:
2584+
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequestBody"
2585+
description: Payment processor authorization code object containing account_guid,
2586+
member_guid, and user_guid.
2587+
required: true
2588+
responses:
2589+
'200':
2590+
content:
2591+
application/vnd.mx.api.v1+json:
2592+
schema:
2593+
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponseBody"
2594+
description: OK
2595+
summary: Request payment processor authorization code
2596+
tags:
2597+
- mx_platform
2598+
"/payment_processor_token":
2599+
post:
2600+
description: Use this endpoint to request a payment processor token.
2601+
operationId: requestPaymentProcessorToken
2602+
parameters:
2603+
- description: Code to request processor token.
2604+
example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
2605+
in: query
2606+
name: code
2607+
schema:
2608+
type: string
2609+
- description: Specify grant type.
2610+
example: authorization_code
2611+
in: query
2612+
name: grant_type
2613+
schema:
2614+
type: string
2615+
responses:
2616+
'200':
2617+
content:
2618+
application/vnd.mx.api.v1+json:
2619+
schema:
2620+
"$ref": "#/components/schemas/PaymentProcessorTokenResponseBody"
2621+
description: OK
2622+
summary: Request payment processor token
2623+
tags:
2624+
- mx_platform
24762625
"/transactions/enhance":
24772626
post:
24782627
description: Use this endpoint to categorize, cleanse, and classify transactions.

0 commit comments

Comments
 (0)