Skip to content

Commit 65769a0

Browse files
Merge pull request #71 from mxenabled/bm/partner_endpoints
Replace PaymentProcessor with Partner
2 parents 35d8e72 + 2ec93e9 commit 65769a0

1 file changed

Lines changed: 33 additions & 34 deletions

File tree

openapi/mx_platform_api.yml

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1560,7 +1560,7 @@ components:
15601560
example: 1
15611561
type: integer
15621562
type: object
1563-
PaymentAccountResponse:
1563+
PartnerAccountResponse:
15641564
properties:
15651565
account_name:
15661566
example: My Savings
@@ -1591,12 +1591,12 @@ components:
15911591
nullable: true
15921592
type: string
15931593
type: object
1594-
PaymentAccountResponseBody:
1594+
PartnerAccountResponseBody:
15951595
properties:
1596-
payment_account:
1597-
"$ref": "#/components/schemas/PaymentAccountResponse"
1596+
partner_account:
1597+
"$ref": "#/components/schemas/PartnerAccountResponse"
15981598
type: object
1599-
PaymentProcessorAuthorizationCodeRequest:
1599+
PartnerAuthorizationCodeRequest:
16001600
properties:
16011601
account_guid:
16021602
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
@@ -1608,31 +1608,31 @@ components:
16081608
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
16091609
type: string
16101610
type: object
1611-
PaymentProcessorAuthorizationCodeRequestBody:
1611+
PartnerAuthorizationCodeRequestBody:
16121612
properties:
1613-
payment_processor_authorization_code:
1614-
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequest"
1613+
partner_authorization_code:
1614+
"$ref": "#/components/schemas/PartnerAuthorizationCodeRequest"
16151615
type: object
1616-
PaymentProcessorAuthorizationCodeResponse:
1616+
PartnerAuthorizationCodeResponse:
16171617
properties:
16181618
authorization_code:
16191619
example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
16201620
nullable: true
16211621
type: string
16221622
type: object
1623-
PaymentProcessorAuthorizationCodeResponseBody:
1623+
PartnerAuthorizationCodeResponseBody:
16241624
properties:
1625-
payment_processor_authorization_code:
1626-
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponse"
1625+
partner_authorization_code:
1626+
"$ref": "#/components/schemas/PartnerAuthorizationCodeResponse"
16271627
type: object
1628-
PaymentProcessorTokenResponseBody:
1628+
PartnerTokenResponseBody:
16291629
properties:
16301630
access_token:
16311631
example: jUmJS4AZVdvywAMO_JWKwZ8fvY9ZZQINSBHTKkHMw-c
16321632
nullable: true
16331633
type: string
16341634
scope:
1635-
example: payment_accounts
1635+
example: Platform#partner_accounts
16361636
nullable: true
16371637
type: string
16381638
token_type:
@@ -2560,51 +2560,50 @@ paths:
25602560
summary: Read merchant
25612561
tags:
25622562
- mx_platform
2563-
"/payment_account":
2563+
"/partner_account":
25642564
get:
2565-
description: Use this endpoint to request a payment account.
2566-
operationId: requestPaymentAccount
2565+
description: Use this endpoint to request a partner account.
2566+
operationId: requestPartnerAccount
25672567
responses:
25682568
'200':
25692569
content:
25702570
application/vnd.mx.api.v1+json:
25712571
schema:
2572-
"$ref": "#/components/schemas/PaymentAccountResponseBody"
2572+
"$ref": "#/components/schemas/PartnerAccountResponseBody"
25732573
description: OK
25742574
security:
25752575
- bearerAuth: []
2576-
summary: Request payment account
2576+
summary: Request partner account
25772577
tags:
25782578
- mx_platform
2579-
"/payment_processor_authorization_code":
2579+
"/partner_authorization_code":
25802580
post:
2581-
description: Use this endpoint to request a payment processor authorization
2582-
code.
2583-
operationId: requestPaymentProcessorAuthorizationCode
2581+
description: Use this endpoint to request a partner authorization code.
2582+
operationId: requestPartnerAuthorizationCode
25842583
requestBody:
25852584
content:
25862585
application/json:
25872586
schema:
2588-
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeRequestBody"
2589-
description: Payment processor authorization code object containing account_guid,
2590-
member_guid, and user_guid.
2587+
"$ref": "#/components/schemas/PartnerAuthorizationCodeRequestBody"
2588+
description: Partner authorization code object containing account_guid, member_guid,
2589+
and user_guid.
25912590
required: true
25922591
responses:
25932592
'200':
25942593
content:
25952594
application/vnd.mx.api.v1+json:
25962595
schema:
2597-
"$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponseBody"
2596+
"$ref": "#/components/schemas/PartnerAuthorizationCodeResponseBody"
25982597
description: OK
2599-
summary: Request payment processor authorization code
2598+
summary: Request partner authorization code
26002599
tags:
26012600
- mx_platform
2602-
"/payment_processor_token":
2601+
"/partner_token":
26032602
post:
2604-
description: Use this endpoint to request a payment processor token.
2605-
operationId: requestPaymentProcessorToken
2603+
description: Use this endpoint to request a partner token.
2604+
operationId: requestPartnerToken
26062605
parameters:
2607-
- description: Code to request processor token.
2606+
- description: Code to request partner token.
26082607
example: sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM
26092608
in: query
26102609
name: code
@@ -2621,9 +2620,9 @@ paths:
26212620
content:
26222621
application/vnd.mx.api.v1+json:
26232622
schema:
2624-
"$ref": "#/components/schemas/PaymentProcessorTokenResponseBody"
2623+
"$ref": "#/components/schemas/PartnerTokenResponseBody"
26252624
description: OK
2626-
summary: Request payment processor token
2625+
summary: Request partner token
26272626
tags:
26282627
- mx_platform
26292628
"/transactions/enhance":

0 commit comments

Comments
 (0)