User Tools

Site Tools


developers:api:payment_details

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Last revision Both sides next revision
developers:api:payment_details [2014/10/16 13:08]
Jaco van Wyk created
developers:api:payment_details [2014/10/18 08:00]
Jaco van Wyk
Line 1: Line 1:
 ====== Payment Details ====== ====== Payment Details ======
  
 +===== /​v1/​payment_details/​id/​get =====
 +
 +Retrieve payment_details by id and return the details.
 +
 +===== /​v1/​payment_details/​id/​update =====
 +
 +Update payment details by id.
 +
 +<code php>
 +    $ curl -u user:pass -d "​expiry=2025-06"​ \
 +    >      https://​api.snapbill.com/​v1/​payment_details/​143476/​update.json
 +<​code>​
 +
 +<source examples/​payment_details.txt-1.json>​
 +
 +==== Parameter listing ====
 +
 +^Name ^Availability ^^Description^
 +|depth |get | |The depth parameter signals the amount of data for the payment details provided. depth=0 is the highest level that provides full detail.|
 +|id |get | |The id of the payment details in the system. This is guaranteed to be unique only over a single account.|
 +|xid |get | |The xid of the payment details in the system. This is guaranteed to be unique over all accounts.|
 +|client |get | |The client the payment was for.|
 +|type |get | |The type of payment details (usually bank_account or credit_card).|
 +|bank |get | |The bank the payment details are with. Will also list visa/​mastercard/​etc in the case of credit cards.|
 +|number |get | |The credit card or bank account number. Hidden digits are replaced with *'s.|
 +|expiry |get |update |The expiry date for credit cards (null on bank accounts)|
 +|last4 |get | |The last four unencrypted digits of the bank account number or credit card.|
 +|state |get | |The current state of the payment details (active, disabled, expired or dead).|
 +
 +===== /​v1/​payment_details/​list =====
 +
 +List all payment_details of all clients on the account.
 +
 +Results can optionally be filtered by the filters listed below.
 +
 +<code php>
 +    $ curl -u user:pass -d "​perpage=2"​ \
 +    >      https://​api.snapbill.com/​v1/​payment_details/​list.json
 +</​code>​
 +
 +<source examples/​payment_details.txt-2.json>​
 +
 +==== List Payment Details Filters ====
 +
 +^Name ^Availability ^Description^
 +|client_id |get |The client associated with the payment details.|
 +|page |get |The page of results to return.|
 +|perpage |get |The number of results per page to return.|
developers/api/payment_details.txt ยท Last modified: 2014/10/18 08:00 by Jaco van Wyk