Explore a full, working code sample of a Payment integration with our Application Programming Interface (API). This documentation will outline the basic steps of charging a payment by id or reference number from the policyPay system. With your program set up in our production environment, it will be ready for live testing. When successful testing is completed, real Payments can be created.

Once you submit to the API, you can see the accounts in the UI at policypay.io by logging in with your given credentials.

We recommend using Postman for all of our API routes. Download our Postman collection using the link below: Download Postman Collection. Our respective Production and Sandbox URLs are the following: rest.policypay.io/payment/charge/{ref} or uat-rest.policypay.io/payment/charge/{ref}.

User Credentials

Email: ***

Password: ***

Public Key: ***

Secret Key: ***

URL: /payment/charge/{ref}

A response payload will be returned which includes your API endpoints along with a successul 200 code displayed. See Response Codes below for further details.

Your API endpoint definitions will vary and be custom for your specific needs. The following is an example.

Variable	Type	Required	Notes
ref (path)	String	Yes	Reference number

Sample JSON Response

{
  "status": "success",
  "message": "string",
  "order": {
    "status": "Pending",
    "paymentMethod": "credit card",
    "uniqueNumber": "string",
    "amount": 0,
    "fee": 0,
    "orig_amount": 0,
    "billingInfo": {
      "name": "string",
      "phone": "string",
      "email": "string",
      "address1": "string",
      "address2": "string",
      "zip": "string",
      "city": "string",
      "state": "string"
    },
    "itemInfo": {
      "name": "string",
      "description": "string"
    },
    "extra": {
      "company_name": "string"
    }
  }
}

Response Codes

Code	Description
200	Payment charged successfully
400	Failed to create Payment
422	Unprocessable entry
500	Internal server error

Charge a Payment

URL: /payment/charge/{ref}