Getting Started with Monetary Pay API

Authorization

Authorization is easy, just insert your secret key in the Authorization header:

Authorization: secretKEYGOESHERE

Identification

Let us know who you are! Send your product name and version in the User-Agent header:

User-Agent: AwesomePOS/1.2.3

Content Types

Communicate with us in your favorite content type!

We support the following for Content-Type and Accepts values:

• application/json
• application/xml
• x-www-url-encoded

Transactions

Credit Transactions

• Supported Transactions GET /credit
• Sale POST /credit/sale
• Void Sale POST /credit/sale/{RefNo}/void
• Adjust PUT /credit/sale/{RefNo}
• Return POST /credit/return
• Void Return POST /credit/return/{RefNo}/void
• PreAuth POST /credit/preauth
• Capture PUT /credit/preauth/{RefNo}
• Auth Only POST /credit/authonly
• Transaction Detail GET /credit/{RefNo}

Debit Transactions

• Sale POST /debit/sale
• Return POST /debit/return

Stored Value Transactions

• Load POST /storedvalue/load
• Void Load POST /storedvalue/load/{RefNo}/void
• Sale POST /storedvalue/sale
• Void Sale POST /storedvalue/sale/{RefNo}/void
• Balance POST /storedvalue/balance
• Create POST /storedvalue/create
• Set POST /storedvalue/set
• Transaction Detail GET /storedvalue/{RefNo}

Administrative Requests

• Batch Summary GET /admin/batchsummary
• Batch Close POST /admin/batchclose

Success Responses

• 200 OK Approved Transaction
• 402 PAYMENT REQUIRED Declined Transaction

Failure Responses

• 400 BAD REQUEST Invalid Transaction Request
• 401 UNAUTHORIZED Unauthorized Transaction
• 404 NOT FOUND Resource Not Found

Example Credit Sale Request

POST https://pay.monetary.co/v1/credit/sale

Authorization: secretKEYGOESHERE
User-Agent: AwesomePOS/1.2.3
Content-Type: application/json
Accept: application/json

{
  "Amount": "1.00",
  "Account": "4242424242424242",
  "Expiration": "1220"
}

Example Credit Sale Response

200 OK

{
  "Status": "Approved",
  "Message": "APPROVAL",
  "Account": "XXXXXXXXXXXX4242",
  "Expiration": "XXXX",
  "Brand": "VISA",
  "AuthCode": "ABC123",
  "RefNo": "123",
  "Amount": "1.00",
  "Authorized": "1.00",
  "Token": "card1ABCDEFG2"
}

Using Tokens

As you can see in the example response above, every successful transaction response will include a Token which you can use in subsequent transactions for that account!

For example, this is how to void the above example sale using the RefNo and Token it returned:

Example Credit Void Request with Token

POST https://pay.monetary.co/v1/credit/sale/123/void

Authorization: secretKEYGOESHERE
User-Agent: AwesomePOS/1.2.3
Content-Type: application/json
Accept: application/json

{
  "Token": "card1ABCDEFG2"
}

Example Credit Void Response with Token

200 OK

{
  "Status": "Approved",
  "Message": "APPROVAL",
  "Account": "XXXXXXXXXXXX4242",
  "Expiration": "XXXX",
  "Brand": "VISA",
  "RefNo": "124",
  "Amount": "1.00",
  "Authorized": "1.00",
  "Token": "card1ABCDEFG2"
}