Customer Payment

Customer Payment

This API allows you to add a payment for a customer.

URI

/:tokenid/customer/payment/:cid

:cid variable can be either the customer id, account_id or crm_id

Method

POST - json object

Request Parameters:

  • tokenid: (Required) Your unique API access token.

  • cid: (Required) The customer ID you want to charge

Body:

field

type

notes

Required

field

type

notes

Required

card_on_file

boolean

Use the card on file

 

bank_on_file

boolean

Use the bank details on file

 

payment_token

string

The single use payment token to use

**

cc_name

string

Credit Card Name

*

cc_number

integer

Credit Card Number

*

cc_expmonth

string

Credit Card Expiry Month ( 2 digit with leading 0 )

*

cc_expyear

int

Credit Card Expiry Year ( 4 digit )

*

cc_ccv

string

CCV number of credit card

*

store_card

bool

Update the customer’s card on file for future use

 

amount

float

decimal value to be charged must be >= 1

Yes

Note:
* either *on_file, payment_token or all card fields required.
** payment_token not available on all payment gateways, please if your gateway supports that.

Notes:

Support payment_token Gateways

  • Till Payments

Response:

{ "success": true, "description": "Success" }