Collect payments

Make a request to process a one-time payment, authorization, or recurring charge from a previously tokenized card.

One-time payment

The following properties are required to process a one-time payment.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardToken	Card token.
cvv	3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amount	Amount of the transaction.

One-time payment example

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "cvv": "111",
  "amount": 100
}

Authorization

The following properties are required to process an authorization.

PROPERTY	DESCRIPTION
apiKey	.
cardToken	Card token.
cvv	3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amount	Amount of the transaction.
txnType	Send the value `checkIn`.

Note: you have 20 days to capture an authorization. After that time, the held funds will be released by the issuing bank back to the cardholder.

Example of an authorization

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "cvv": "111",
  "amount": 100,
  "txnType": "checkIn"
}

Recurring charge

The following properties are required to process a recurring charge.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardToken	Card token.
cvv	3 digits for Visa and Mastercard cards.
amount	Amount of the transaction.
txnType	Send the value `recurring`.
contractNumber	Contract number.

Note: American Express cards are not supported for recurring transactions.

Example of a recurring charge

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "cvv": "111",
  "amount": 100,
  "txnType": "recurring",
  "contractNumber": "contract123"
}

Recurring checkIn charge

The following properties are required to process a recurring checkIn charge.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardToken	Card token.
cvv	3 digits for Visa and Mastercard cards.
amount	Amount of the transaction.
txnType	Send the value `recurringCheckIn`.
contractNumber	Contract number.

Note: American Express cards are not supported in recurring checkIn transactions.

Example of a recurring checkIn charge

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "cvv": "111",
  "amount": 100,
  "txnType": "recurringCheckIn",
  "contractNumber": "contract123"
}

Deferreds

The following properties are required to process a deferred payment.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardToken	Card token.
cvv	3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amount	Amount of the transaction.
paymentPlan	Amount of installments.

Example of a deferred payment

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "cvv": "111",
  "amount": 600,
  "paymentPlan": 3

}

Single payment American Express cards without 4DBC

The following properties are required to process a one-time payment with American Express cards without 4DBC.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardToken	Card token.
amount	Amount of the transaction.
amexCustAddress	Cardholder Billing Address.
amexCustFirstName	Cardholder First Name.
amexCustLastName	Cardholder Last Name.
amexCustEmailAddr	Cardholder Email Address.
amexCustBrowserTypDescTxt	Customer user agent.
amexCustHostServerNm	Customer Host Server Name.
amexCustIdPhoneNbr	Cardholder Phone Number.
amexCustIPAddr	Customer IP Address.
amexCustPostalCode	Cardholder Billing Postal Code.
amexMerSKUNbr	Merchant SKU Number.

Example of a one-time payment with American Express cards without 4DBC

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
  "amount": 100,
  "amexCustAddress": "18850 N 56 ST APT301",
  "amexCustFirstName": "JANE",
  "amexCustLastName" : "SMITH",
  "amexCustEmailAddr": "jane@smith.com",
  "amexCustBrowserTypDescTxt": "MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;  ~WINDOWS~95",
  "amexCustHostServerNm" : "comercio.com",
  "amexCustIdPhoneNbr" : "3333333333",
  "amexCustIPAddr" : "169.10.10.10",
  "amexCustPostalCode" : "00001",
  "amexMerSKUNbr" : "MYSKU0001"
}

Tokenless payments

You can collect payments without needing to tokenize a card first. Send the card data inside the cardReq object instead of sending the cardToken property with the card token.

The following properties are required to process a payment without generating a card token.

PROPERTY	DESCRIPTION
apiKey	Api key.
cardReq	Object with card information.
cardReq.pan	Primary Account Number.
cardReq.cvv2	3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
cardReq.expDate	Expiration date (`YYMM`).
amount	Amount of the transaction.

Example of a tokenless payment

{
  "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
  "cardReq" : {
    "pan" : "4000000000000002", 
    "cvv2" : "111", 
    "expDate" : "3012"
  },
  "amount": 100
}

curl --location 'https://api-uat.kushkipagos.com/scops/txn' \ --header 'Content-Type: application/json' \ --data '{ "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA", "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw", "cvv": "111", "amount": 100 }'

One-time payment

One-time payment example

Authorization

Example of an authorization

Recurring charge

Example of a recurring charge

Recurring checkIn charge

Example of a recurring checkIn charge

Deferreds

Example of a deferred payment

Single payment American Express cards without 4DBC

Example of a one-time payment with American Express cards without 4DBC

Tokenless payments

Example of a tokenless payment

Request

Responses

Collect payments

One-time payment#

One-time payment example#

Authorization#

Example of an authorization#

Recurring charge#

Example of a recurring charge#

Recurring checkIn charge#

Example of a recurring checkIn charge#

Deferreds#

Example of a deferred payment#

Single payment American Express cards without 4DBC#

Example of a one-time payment with American Express cards without 4DBC#

Tokenless payments#

Example of a tokenless payment#

Request

Responses

One-time payment

One-time payment example

Authorization

Example of an authorization

Recurring charge

Example of a recurring charge

Recurring checkIn charge

Example of a recurring checkIn charge

Deferreds

Example of a deferred payment

Single payment American Express cards without 4DBC

Example of a one-time payment with American Express cards without 4DBC

Tokenless payments

Example of a tokenless payment