Microsoft Payments Reverse API
API Specification for payment provider integrations
Enrollment and Transaction APIs
Enroll, De-Enroll, Capture, Refund, Query, etc.
Notification Service APIs
Specification for calling Microsoft's account/transaction notification listeners
Electronic Payment Advice (EPA) spec
Standard for publishing daily payment journal for reconciliation purposes
Discovery Service
Detailed information on available payment methods in each market, supported capabilities for each method, and exact expected payload for Enrollment and Transaction calls
About Microsoft Payments Reverse API
Microsoft's Reverse API is a unique way for Payment Service Providers (PSPs) to connect with Microsoft's ecosystem in order to process transactions for Microsoft. Rather than relying on the PSP's API set, in this case Microsoft is defining the API, while the PSP should implement it and expose it to calls from Microsoft (hence, Reverse API).
For more information on supported scenarios, authentication model, etc. please refer to the introduction document here.
Our APIs
Reverse APIs
Everything needed to implement the various APIs and learn about each PI's payload
Electronic Payment Advice
Specification for daily settlement / reconciliation files (EPA)
Please read carefully through all the APIs listed here, as well as the payloads defined in the Discovery Service, to determine what capabilities you would need to implement.
On the right, have a look at a sample /capture call that can be made on a credit card.
POST /Payments/Capture
{
"merchantId": "Microsoft",
"merchantDescriptor": "MSFT *XBOX",
"merchantCategoryCode": "1234",
"timestamp": "2020-10-08T20:32:00Z",
"merchantReferenceNumber": "ZDSF2342FSW24",
"paymentDetails":
{
"paymentInstrumentType": "credit_card",
"paymentInstrumentBrand": "visa",
"paymentInstrument":
{
"cardholderName": "John Doe",
"billingZipcode": "98052",
"encryptedData":
{
"cardNumber": "dfhnkgbhfjnvkdjhgsdhjsfw34234kfhskjfhsjkfhkjsfhkjshfkjshfkjshfkjshfkjshfksfhfkjhdkjghkjghkjfhkjsdfhsdkjfhksjfhkjsfhkjshfkjshfkjshfkjshfkjshfjkshfjkshfjkshfkjshfjkshf2",
"cvv": "fkshfjksdhfjksdhfkjsdehjkeswhfjksdhfjksdhfjksdhfjksdhfjk"
},
"captureType": "authorize",
"amount": 123.45,
"taxAmount": 12.34,
"currency": "USD",
"isRecurring": false,
"accountIdHash": 3424234234263,
},
"productDetails":
[
{
"catalogId": "gearsofwar5",
"productName": "Gears Of War 5",
"publisherName": "Microsoft Studios",
"chargeAmount": 123.45,
"taxAmount": 12.34,
"quantity": 1,
}
]
},
"transactionType": "Online"
}
Contact Us
For any questions regarding the usage of Reverse API, please reach out to Universal Store Reverse API (ustrevapisup@microsoft.com)