Payments

Create Payments

payment.create Create a new payment and returns the corresponding payment_id.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="payment.create">
  <payment>
  	<invoice_id>1</invoice_id> 			//mandatory
  	<amount>2.34</amount>				//mandatory
  	<date>2007-09-28</date>				//mandatory
  	<payment_method>PM1234567</payment_method>
  	<number>3456</number>
	</payment>
</request>

Response

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <payment_id>1</payment_id>
</response>

Update Payments

payment.update Update an existing payment. All fields besides payment_id are optional - unpassed fields will retain their existing value.

Get Payments

payment.get Retrieve payment details according to payment_id.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="payment.get">
  <payment_id>1</payment_id>
</request>

Reponse

<?xml version="1.0"?>
<response status="ok">
  <payment>
  	<payment_id>1</payment_id>
  	<invoice_id>1</invoice_id>
  	<amount>2.34</amount>
  	<date>2007-09-28</date>
  	<payment_method>PM1234567</payment_method>
  	<number>3456</number>
	</payment>
</response>

Delete Payments

payment.delete Delete the payment with the given payment_id.

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="payment.delete">
  <payment_id>1</payment_id>
</request>

Response

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok"/>

List Payments

payment.list

Request

<?xml version="1.0" encoding="UTF-8"?>
<request method="payment.list">
  <client_id>1</client_id>            # Filter by client (Optional)
  <date_from>2007-01-01</date_from>   # Return payments dated after this arg (Optional)
  <date_to>2007-09-28</date_to>       # Return payments dated before this arg (Optional)
  <page>1</page>                      # Page number to return, default is 1 (Optional)
  <per_page>10</per_page>             # Number of results per page, default is 25 (Optional)
</request>

Response

<?xml version="1.0"?>
<response status="ok">
  <payment>
  	<payment_id>1</payment_id>
  	<invoice_id>1</invoice_id>
  	<amount>2.34</amount>
  	<date>2007-09-28</date>
  	<payment_method>PM1234567</payment_method>
  	<number>3456</number>
	</payment>
</response>
 
acuinvoice_api/payments.txt · Last modified: 2008/03/17 11:17 by admin
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki