{"info":{"_postman_id":"110588c8-1fde-42f9-bb3f-0a7934b0efab","name":"Cliq Send API Documentation","description":"

Cliq Send is our suite of APIs that will allow you to send money to credit and debit cards.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13102921","collectionId":"110588c8-1fde-42f9-bb3f-0a7934b0efab","publishedId":"2sB34eHgoY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"666666","highlight":"161041"},"publishDate":"2025-07-11T19:30:48.000Z"},"item":[{"name":"Query Card","id":"6be8891f-edae-436d-b700-946744492c49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://apitest.cfinc.com/api/1.0/sendt/card/query","description":"

This function will allow you to retrieve attributes about a card. This includes Address Verification and Account Name Inquiry as optional searches.

This request requires either an accountId for a stored customer profile or the token retrieved from the PCI Compliant iFrame.

Request

Headers:
\n
- Content-Type: application/json
  \n
- Authorization: Bearer Token
  \n
\n
Body Parameters:
\n
- programId (number, required): Cliq Assigned identification number
  \n
- referenceId (string, required): Unique identifier for the request
  \n
- avsCheck (boolean, required): Set to true to perform Address Verification on the card
  \n
- aniCheck (boolean, required): Set to true to perform an Account Name Inquiry on the card
  \n
- account (object, conditional)
  \n
  - accountId (string, conditional): 22-character Account ID.
    Required unless submitting card token.
  \n
- card (object, conditional)
  \n
  - token (string, conditional): Card Token from the PCI Compliant iFrame.
    Required unless submitting AccountId.
  \n
- owner (object, required)
  \n
  - name (object, required)
    \n
    - company (string, conditional): Company name on card.
      Required unless submitting First Name and Last Name
      \n
    - first (string, conditional): Cardholder first name
      Required unless submitting Company Name
      \n
    - last (string, conditional): Cardholder last name
      Required unless submitting Company Name
      \n
    \n
  - address (object, conditional)
    Required if requesting Address Verification (AVS)
    \n
    - line1 (string, optional): Billing address line 1
      \n
    - line2 (string, optional): Billing address line 2
      \n
    - city (string, optional): Billing address city
      \n
    - state (string, optional): Billing address state code
      State Code must be a valid 2-character code if country is 840__or Canadian 2-char code if 124
      \n
    - zipCode (string, optional): Billing address zip code
      If the country value is 840, zipCode must be 5 or 9 digits. If the country value is 124, zipCode must be in the A1A 1A1 format. Zip Codes from other countries will not be checked.
      \n
    - country (string, optional): Billing address country
      Default value is 840 (US)
      \n
    \n
  \n
- currency (string, optional): Currency code of the transaction, default 840
  \n
- timeout (string, optional): Number of seconds before the request times out
  \n
\n

Response

Success (200 OK):
\n
- succeeded (boolean): status of the request
  \n
- data.sc (number): HTTP Status Code
  \n
- data.ec (string): Internal Error Code
  \n
- data.em (string): Short description of the error if an error occurred
  \n
- data.card.bin (string): First 6 digits of the card number
  \n
- data.card.last4 (string): Last 4 digits of the card number
  \n
- data.card.issuerName (string): Issuer Name
  \n
- data.card.pull.enabled (boolean): Eligible for sale or authorization transactions
  \n
- data.card.pull.network (string): Payment network
  \n
- data.card.pull.type (string): Product type – Credit, Debit, Prepaid
  \n
- data.card.pull.regulated (boolean): Exempt/non-exempt from the debit card interchange fee standards
  \n
- data.card.pull.currency (string): Corresponding issuer billing currency code
  \n
- data.card.pull.country (string): Corresponding issuer country code
  \n
- data.card.push.enabled (boolean): Eligible as a destination for sending money
  \n
- data.card.push.network (string): Payment network
  \n
- data.card.push.type (string): Product type – Credit, Debit, Prepaid
  \n
- data.card.push.availability (string): Estimated Funds Availability: Immediate (usually within 30 minutes), Next Business Day, Few Business Days (more than 1 business day)
  \n
- data.card.push.regulated (boolean): Exempt/non-exempt from the debit card interchange fee standards
  \n
- data.card.push.currency (string): Corresponding issuer billing currency code
  \n
- data.card.push.country (string): Corresponding issuer country code
  \n
- data.avs.avsId (string): AVS Transaction Identifier
  \n
- data.avs.networkRc (string): Network Response Code
  \n
- data.avs.networkId (string): NetworkID
  \n
- data.avs.authorize.Id (string): ID number
  \n
- data.avs.codeAva (string): AVS Result Text
  \n
- data.avs.resultText (string): AVS Result Text
  \n
- data.avs.codeSecurityCode (string): AVS Response Code
  \n
- data.avs.par (string): Payment Account Reference
  \n
- data.avs.ani.codeMatch (string): Whether the ANI match was performed. \"M\" Match was performed. \"N\" Match was not performed. \"U\" ANI is not supported.
  \n
- data.avs.ani.codeFullName (string): Match result. \"M\" Match. \"P\" Partial Match. \"N\" No Match.
  \n
- data.avs.ani.codeFirstName (string): Match result. \"M\" Match. \"P\" Partial Match. \"N\" No Match.
  \n
- data.avs.ani.codeLastName (string): Match result. \"M\" Match. \"P\" Partial Match. \"N\" No Match.
  \n
\n
Error (4* or 500):
\n
- succeeded (boolean)
  \n
- data.sc (number): HTTP Status Code
  \n
- data.ec (string): Internal Error Code
  \n
- data.em (string): Short description of the error if an error occurred
  \n
- data.programId (string): echo of the program ID
  \n
- data.referenceId (string): echo of the supplied reference ID
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","1.0","sendt","card","query"],"host":["apitest","cfinc","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"eac59030-a528-4e39-8e02-0ac22185e56a","name":"Query Card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"programId\": 0,\r\n \"referenceId\": \"0\",\r\n \"avsCheck\": false,\r\n \"aniCheck\": false,\r\n \"card\": {\r\n \"token\": \"token\"\r\n },\r\n \"owner\": {\r\n \"name\": {\r\n \"first\": \"first\",\r\n \"last\": \"last\"\r\n },\r\n \"address\": {\r\n \"line1\": \"line1\",\r\n \"line2\": \"line2\",\r\n \"city\": \"city\",\r\n \"state\": \"CA\",\r\n \"zipcode\": \"92626\",\r\n \"country\": \"840\"\r\n }\r\n },\r\n \"currency\": \"840\",\r\n \"timeout\": \"30\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apitest.cfinc.com/api/1.0/sendt/card/query","protocol":"https","host":["apitest","cfinc","com"],"path":["api","1.0","sendt","card","query"],"query":[{"key":"AVS+ANI","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeeded\": true,\r\n \"data\": {\r\n \"sc\": 200,\r\n \"ec\": \"0\",\r\n \"card\": {\r\n \"bin\": \"411111\",\r\n \"last4\": \"1111\",\r\n \"issuerName\": \"FORD Instiution\",\r\n \"pull\": {\r\n \"enabled\": true,\r\n \"network\": \"Visa\",\r\n \"type\": \"Credit\",\r\n \"regulated\": true,\r\n \"currency\": \"840\",\r\n \"country\": \"840\"\r\n },\r\n \"push\": {\r\n \"enabled\": true,\r\n \"network\": \"Visa\",\r\n \"type\": \"Credit\",\r\n \"regulated\": true,\r\n \"currency\": \"840\",\r\n \"country\": \"840\",\r\n \"availability\": \"Immediate\"\r\n }\r\n },\r\n \"programId\": 100005,\r\n \"referenceId\": \"54200740\"\r\n }\r\n}"}],"_postman_id":"6be8891f-edae-436d-b700-946744492c49"},{"name":"Create Account","id":"7ad988a6-f015-4357-b022-0917582253f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://apitest.cfinc.com/api/1.0/sendt/accounts","description":"

Use this function to take the token from the PCI Compliant iFrame and store it securely in the vault. You will then be able to utilize the accountId that we return you when sending funds.

This request requires the token retrieved from the PCI Compliant IFrame.

Request

Headers:
\n
- Content-Type: application/json
  \n
- Authorization: Bearer Token
  \n
\n
Body Parameters:
\n
- programId (number, required): Cliq-assigned identification number
  \n
- referenceId (string, required): Unique identifier for the request
  \n
- card (object, required):
  \n
  - token (string, required): Card token (from the PCI-compliant iFrame)
  \n
- owner (object, required)
  \n
  - name (object, required)
    \n
    - company (string, conditional): Company name on card.
      Required unless submitting first and last name
      \n
    - first (string, conditional): Cardholder first name
      Required unless submitting company name
      \n
    - last (string, conditional): Cardholder last name
      Required unless submitting company name
      \n
    \n
  - address (object, optional):
    Required if you are using Address Verification (AVS)
    \n
    - line1 (string, optional): Billing address line 1
      \n
    - line2 (string, optional): Billing address line 2
      \n
    - city (string, optional): Billing address city
      \n
    - state (string, optional): Billing address state code
      State Code must be a valid 2-character code if the country value is 840 or a Canadian 2-char code if country value is 124
      \n
    - zipCode (string, optional): Billing address zip code
      If the country value is 840, the zipcode must be 5 or 9 digits. If the country value is 124, the zipcode must be in the A1A 1A1 format. Zip codes from other countries will not be checked.
      \n
    - country (string, optional): Billing address country code
      Default value is 840 (US)
      \n
    \n
  \n
\n

Response

Success (200 OK):
\n
- succeeded (boolean)
  \n
- data.cs (number): HTTP Status Code
  \n
- data.ec (string): Internal Error Code
  \n
- data.accountId (string): 22 characters assigned accountID representing one card
  \n
- data.programId (string): echo of the program ID
  \n
- data.referenceId (string): echo of the supplied reference ID
  \n
\n
Error (4* or 500):
\n
- succeeded (boolean)
  \n
- data.sc (number): HTTP Status Code
  \n
- data.ec (string): Internal Error Code
  \n
- data.em (string): Short description of the error if an error occurred
  \n
- data.duplicateAccountIds (array): AccountIDs using the same Card Account Number.
  \n
- data.programId (string): echo of the program ID
  \n
- data.referenceId (string): echo of the supplied reference ID
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","1.0","sendt","accounts"],"host":["apitest","cfinc","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"aec0e320-24b5-4113-bec2-e167ea43156a","name":"Create Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"programId\": 0,\r\n \"referenceId\": \"referenceId\",\r\n \"card\": {\r\n \"token\": \"token\"\r\n },\r\n \"owner\": {\r\n \"name\": {\r\n \"first\": \"first\",\r\n \"last\": \"last\"\r\n },\r\n \"address\": {\r\n \"line1\": \"line1\",\r\n \"line2\": \"line2\",\r\n \"city\": \"city\",\r\n \"state\": \"CA\",\r\n \"zipcode\": \"92626\",\r\n \"country\": \"840\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apitest.cfinc.com/api/1.0/sendt/accounts","protocol":"https","host":["apitest","cfinc","com"],"path":["api","1.0","sendt","accounts"],"query":[{"key":"","value":"","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeeded\": true,\r\n \"data\": {\r\n \"accountId\": \"accountId\",\r\n \"sc\": 200,\r\n \"ec\": \"0\",\r\n \"programId\": 0,\r\n \"referenceId\": \"referenceId\"\r\n }\r\n}"}],"_postman_id":"7ad988a6-f015-4357-b022-0917582253f8"},{"name":"Send Funds","id":"458fad51-7d5b-4bb3-8334-c55cc792da75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://apitest.cfinc.com/api/1.0/sendt/card/transaction/credit","description":"

Use this function to take the accountId received from the Create Account call and send funds to that card.

For debit cards, funds are generally available within 30 minutes. For credit cards, funds are generally available the next business day. The Query Card function will provide more detail for specific cards in the data.card.push.availability value of the response.

Request

Headers:
\n
- Content-Type: application/json
  \n
- Authorization: Bearer Token
  \n
\n
Body Parameters:
\n
- programId (number, required): Cliq Assigned identification number
  \n
- referenceId (string, required): Unique identifier for the request
  \n
- clerkId (string, optional): User Identifier for reporting purposes.
  \n
- accounts (object, required):
  \n
  - accountId (string, required): AccountID to be funded, from the Create Account call
  \n
- amount (string, required): Amount to be sent to the account on file.
  \n
- softDescriptor (object, optional):
  If passing a custom descriptor, all fields below are required.
  \n
  - name (string, required): Name to show on cardholder statement
    \n
  - address (object, optional):
    \n
    - line1 (string, required): Address line 1 to show on cardholder statement
      \n
    - line2 (string, required): Address line 2 to show on cardholder statement
      \n
    - city (string, required): City to show on cardholder statement
      \n
    - state (string, required): State to show on cardholder statement
      \n
    - zipCode (string, required): Zip code to show on cardholder statement
      \n
    - country (string, required): Country code of the country to show on the cardholder statement
      \n
    \n
  \n
\n

Response

Success (200 OK):
\n
- succeeded (boolean)
  \n
- data.transactionId (string): Processor identification number
  \n
- data.network (string): Network of the card
  \n
- data.networkRc (string): Network response code
  \n
- data.networkId (string): Network identification number
  \n
- data.status (string): Status of the transaction
  \n
- data.approvalCode (string): Authorization code
  \n
- data.card.last4 (string): Last 4 digits of the card number the funds were sent to
  \n
- data.card.expirationDate (string): Expiration date of the card the funds were sent to
  \n
- data.additional.par (string): PAR value
  \n
- data.sc (number): HTTP status code
  \n
- data.ec (string): Internal error code
  \n
- data.cliqTransactionId (string): Cliq Transaction Identification Number
  \n
- data.programId (string): echo of the programId
  \n
- data.referenceId (string): echo of the supplied referenceId
  \n
\n
Error (4* or 500):
\n
- succeeded (boolean)
  \n
- data.status (string): status of the transfer request
  \n
- data.sc (number): HTTP status code
  \n
- data.ec (string): Internal error code
  \n
- data.programId (string): echo of the programId
  \n
- data.referenceId (string): echo of the supplied referenceId
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","1.0","sendt","card","transaction","credit"],"host":["apitest","cfinc","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"2116759f-8eb3-4d54-bd60-f4e69538c129","name":"Send Funds","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"programId\": 0,\r\n \"referenceId\": \"referenceId\",\r\n \"accounts\": {\r\n \"accountId\": \"accountId\"\r\n },\r\n \"amount\": \"1.00\",\r\n \"softDescriptor\": {\r\n \"name\": \"soft descriptor\",\r\n \"address\": {\r\n \"line1\": \"123 Main St\",\r\n \"line2\": \"\",\r\n \"city\": \"Costa Mesa\",\r\n \"state\": \"CA\",\r\n \"zipcode\": \"92626\",\r\n \"country\": \"840\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apitest.cfinc.com/api/1.0/sendt/card/transaction/credit","protocol":"https","host":["apitest","cfinc","com"],"path":["api","1.0","sendt","card","transaction","credit"],"query":[{"key":"","value":"","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeeded\": true,\r\n \"data\": {\r\n \"transactionId\": \"transactionId\",\r\n \"network\": \"Visa\",\r\n \"networkRc\": \"00\",\r\n \"networkId\": \"networkId\",\r\n \"status\": \"COMPLETED\",\r\n \"approvalCode\": \"12345679\",\r\n \"card\": {\r\n \"last4\": \"1111\",\r\n \"expirationDate\": \"202708\"\r\n },\r\n \"additional\": {\r\n \"par\": \"par\"\r\n },\r\n \"sc\": 200,\r\n \"ec\": \"0\",\r\n \"cliqTransactionId\": \"cliqTransactionId\",\r\n \"programId\": 0,\r\n \"referenceId\": \"referenceId\"\r\n }\r\n}\r\n"}],"_postman_id":"458fad51-7d5b-4bb3-8334-c55cc792da75"},{"name":"PCI Compliant iFrame","id":"27a448c6-6be5-4900-8776-d1bf3ba26c87","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"host":true,"accept":true,"user-agent":true,"connection":true,"accept-encoding":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"IFRAME","header":[],"description":"

🔐 Overview: What it Is & Why It Matters

Cliq has partnered with our processor TabaPay to provide a secure and PCI Compliant method to collect card and cardholder details for sending funds. The Browser SDK offers a hosted iFrame for collecting card details. Because the iFrame is not hosted by the merchant, no cardholder data flows through merchant systems.

\n\n

🧰 How It Works: From iFrame to Token

Embedding the iFrame:

Include the SDK via referencing the library at https://iframes.sandbox.tabapay.net/TabaPaySDK.js.

Call tabaPaySdk.createIframe({...}), passing configuration like clientId, input styles, labels, and event handlers for submit, cancel, and focusChange

Tokenization Workflow:
On submit, the iFrame returns a pipe-separated string: last4|exp-mm/yy|encryptedToken. The encryptedToken (the third part) is what you send to Cliq's Create Account, or Query Card APIs.

The token expires in about 5 minutes—use it promptly or create an account immediately

🎨 Customization Options

Fully theme-able UI to match your branding:

Inputs (cardNumberInput, expirationDateInput, cscInput)

Control placeholders, label text, invalid/error text, formatting (like separators), card brand logos, etc.

Styling options:

labelStyle, inputStyle, invalidStyle, and button configurations (colors, hover states, order)

Event callbacks:
submit, cancel, and focusChange let you hook into UI behavior

✅ Security & Token Lifecycle

Encrypted tokens are short-lived (~5 minutes).

Merchants must strip out the last4 and expiration date from the response, only pass the encrypted token value to the Create Account, or Query Card functions.

📌 PCI Context

By using the hosted iFrame, merchants stay within SAQ A scope.

📚 References & Additional Resources

Browser SDK Guide: conceptual overview and sample code

Browser SDK Reference: full list of customization options and defaults

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"27a448c6-6be5-4900-8776-d1bf3ba26c87"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"a9b37589-8797-4685-9619-5a37e3486fdd","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"086aef2c-dcda-499b-a5b6-acadee5d2708","type":"text/javascript","packages":{},"exec":[""]}}]}