Kushki Developer Portal
  1. CARD PRESENT PAYMENTS (BILLPOCKET)
Kushki Developer Portal
  • Back to home
  • México 🇲🇽
  • Bienvenidos
  • ONLINE PAYMENTS
    • CARD
      • CARD
      • 1. Request a card token
      • 2. Make a charge or deferred charge
      • 3. Void a transaction
      • 4. Refund a transaction
      • 5. Request deferred options
      • 6. Authorize payments
      • 7. Reauthorize payments
      • 8. Capture an authorized payment
      • 9. Bin Info
      • 10. Bin Info V2
      • 11. Validate OTP
      • 12. Verify Account
      • 12. Verify Account
      • 6. Authorize payments
      • 10. Bin Info V2
      • 8. Capture an authorized payment
      • 3. Void a transaction
      • 4. Refund a transaction
      • 7. Reauthorize payments
      • 1. Request a card token
      • 9. Bin Info
      • 5. Request deferred options
      • 2. Make a charge or deferred charge
      • 11. Validate OTP
    • CASH IN
      • 1. Request a cash in token
      • 2. Init Transaction
      • 3. Transaction Status
      • 1. Request a cash in token
      • 2. Init Transaction
      • 3. Transaction Status
    • TRANSFER IN
      • 1. Request a Transfer In token
      • 2. Init Transaction
      • 4. Get Status Copy
      • 1. Request a Transfer In token
      • 4. Get Status Copy
      • 2. Init Transaction
    • TRANSFER OUT
      • 1. Get Bank List
      • 2. Request a Transfer Out token
      • 3. Init Transaction
      • 4. Get Status
      • 5. Wallet Balance
      • 5. Wallet Balance
      • 1. Get Bank List
      • 4. Get Status
      • 2. Request a Transfer Out token
      • 3. Init Transaction
    • ONE-CLICK & SCHEDULED PAYMENTS
      • 1. Request a recurring charge token
      • 2. Create a recurring charge
      • 3. Update recurring charge card data
      • 4. Make an One-click payment
      • 5. Cancel a recurring charge
      • 6. Update a recurring charge
      • 7. Add a temporary charge or discount
      • 8. Authorize payments Copy
      • 9. Capture an authorized payment Copy
      • 10. Get recurring charge Info
      • 1. Request a recurring charge token
      • 8. Authorize payments Copy
      • 3. Update recurring charge card data
      • 6. Update a recurring charge
      • 10. Get recurring charge Info
      • 2. Create a recurring charge
      • 5. Cancel a recurring charge
      • 9. Capture an authorized payment Copy
      • 4. Make an One-click payment
      • 7. Add a temporary charge or discount
    • PAYMENT BUTTON
      • 1. Create a payment button
      • 1. Create a payment button
    • SMARTLINKS V2
      • 1. Create a Smartlink
      • 2. Get a Smartlink
      • 3. Delete a Smartlink
      • 4. Update a Smartlink
      • 1. Create a Smartlink
      • 4. Update a Smartlink
      • 2. Get a Smartlink
      • 3. Delete a Smartlink
    • PAYMENT CREDENTIALS
      • 1. Create a credential
      • 2. Search credentials
      • 3. Advanced search
      • 4. Activate or deactivate
      • 5. Delete credential
      • 6. Update credential
      • 7. Regenerate a credential
      • 3. Advanced search
      • 6. Update credential
      • 5. Delete credential
      • 2. Search credentials
      • 4. Activate or deactivate
      • 7. Regenerate a credential
      • 1. Create a credential
    • COMMISSIONS
      • 1. Get Commission Configuration
      • 1. Get Commission Configuration
    • GATEWAY STATUS
      • 1. Get gateway status
      • 1. Get gateway status
    • ANALYTICS
      • 1. Get transactions list
      • 1. Get transactions list
  • CARD PRESENT PAYMENTS (API RAW)
    • Single payment
    • Get BIN Info
    • BIN info V2
    • Request deferred options
    • Transaction Search
  • CARD PRESENT PAYMENTS (BILLPOCKET)
    • Get token
      POST
    • States
      GET
    • Validate token
      GET
    • Municipalities
      GET
    • Collect payments
      POST
    • Tax companies
      GET
    • Capture an authorized payment
      POST
    • Commercial activities
      GET
    • Refund
      POST
    • Create checkout
      POST
    • Get status
      GET
    • Get checkout details
      GET
    • Collect card payments
      POST
    • Print Ticket
      POST
    • Collect card payments v2
      POST
    • Cancel Push Notification
      POST
    • Get transaction status
      GET
    • Add or update CLABE account
      POST
    • Configure payment link
      POST
    • Get payment link configuration
      GET
    • Create payment link
      POST
    • Update payment link
      PUT
    • List payment links
      GET
    • Delete payment link
      DELETE
    • Add CLABE account
      POST
    • Get token
      POST
    • Get transaction list
      GET
    • Get transaction list v2
      GET
    • Get transaction list v3
      GET
    • Get transaction list v4
      GET
    • Create user
      POST
  1. CARD PRESENT PAYMENTS (BILLPOCKET)

Collect payments

POST
/scops/txn
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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardTokenCard token.
cvv3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amountAmount 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.

PROPERTYDESCRIPTION
apiKey.
cardTokenCard token.
cvv3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amountAmount of the transaction.
txnTypeSend 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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardTokenCard token.
cvv3 digits for Visa and Mastercard cards.
amountAmount of the transaction.
txnTypeSend the value recurring.
contractNumberContract 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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardTokenCard token.
cvv3 digits for Visa and Mastercard cards.
amountAmount of the transaction.
txnTypeSend the value recurringCheckIn.
contractNumberContract 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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardTokenCard token.
cvv3 digits for Visa and Mastercard cards, 4 digits for American Express cards.
amountAmount of the transaction.
paymentPlanAmount 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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardTokenCard token.
amountAmount of the transaction.
amexCustAddressCardholder Billing Address.
amexCustFirstNameCardholder First Name.
amexCustLastNameCardholder Last Name.
amexCustEmailAddrCardholder Email Address.
amexCustBrowserTypDescTxtCustomer user agent.
amexCustHostServerNmCustomer Host Server Name.
amexCustIdPhoneNbrCardholder Phone Number.
amexCustIPAddrCustomer IP Address.
amexCustPostalCodeCardholder Billing Postal Code.
amexMerSKUNbrMerchant 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.

PROPERTYDESCRIPTION
apiKeyApi key.
cardReqObject with card information.
cardReq.panPrimary Account Number.
cardReq.cvv23 digits for Visa and Mastercard cards, 4 digits for American Express cards.
cardReq.expDateExpiration date (YYMM).
amountAmount of the transaction.

Example of a tokenless payment#


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

Request

Header Params

Body Params application/json

Examples

Responses

🟢200
application/json
OK
Body

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST '/scops/txn' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "ojLGcX1ioiAA8FkAAETcOxoAApkpBcQfki80AAAHSsVvA",
    "cardToken": "ntY50io0uijCQGnjVH49DSuc-41kI6y0_WgmYzZcShQAA17r1RPbXqGdFfApcNq73iU1vwAA8Fk0oplw",
    "cvv": "111",
    "amount": 100
}'
Response Response Example
Invalid field contract number in non-recurring txn
{
    "status": -3,
    "message": "Invalid field contract number in non-recurring txn\r\n"
}
Modified at 2026-01-29 23:54:55
Previous
Municipalities
Next
Tax companies
Built with