Create Payment

This API allows partners to post the payment object to the accounting software for the sales. This object should only be used while recording payments for the account sales in the accounting software.

Post a payment to the accounting software

POST https://<PayEngine-host>/api/merchant/:merchantId/accounting/payments

Request

Request Body

Name	Type	Description
id*	string	Unique ID assigned to the sales object (for reconciliation and trouble shooting)
order_number*	string	The unique identifier assigned to the order sale. This will be used for linking the payment with the original account sales.
payment_date*	timestamp	The date time representing the time of the payment (in GMT).
payment_methods*	array	The collection of the payments object
payment_methods.id*	string	The unique identifier for the payment method
payment_methods.name*	string	The payment method name
payment_methods.description	string	Additional notes/description for the payment method
payment_methods.amount*	float	The total Amount of the payment received.
customer	array	The customer object representing the customer details
customer.id	string	The unique identifier for the customer
customer.name	array	Customer Name
customer.name.first_name	string	First name of the customer
customer.name.last_name	string	Last name of the customer
customer.name.business_name	string	Business name of the customer
customer.email_address	string	Email address of the customer
customer.address	array	Address object
customer.address.street_address	string	The street address
customer.address.city	string	City
customer.address.state	string	state
customer.address.zip_code	string	Zip/Postal code of the address
customer.address.country	string	Country of the customer address
customer.phone_number	string	Customer phone number
gratuity	float	Gratuity amount
service_charge	float	Service charges, if any

200

Field Definitions

Field Name	Type	Description	Required?
transaction_reference	string	Transaction reference	Required
order_number	string	Order number of the sales	Required
payment_number	string	Reference number of the payment	Required
status	string	Allowed values - processed | failed	required

Sample Request Body

{
  "id": 3858152,
  "order_date": "2022-06-30T20:24:02",
  "payment_date": "2022-06-30T20:24:02",
  "payment_methods": [
    {
      "id": "23423432"
      "name": "Cash",
      "amount": "112.50"
    }
  ],
  "customer":{
    "name":{
        "first_name":" first Name",
        "last_name": " last name"
    }
  },
  "gratuity": 0
}

Sample Response Body

{
  "transaction_reference": "guid",
  "order_number": "3858152",
  "payment_number": "3858154",
  "status": "processed"
}