Contact us

Credit Card Payments

  • Location
    • The API is located at: https://api.paybypinwheel.com/api/transaction/api
  • Method
    • Post
  • Content-Type
    • application/x-www-form-urlencoded
  • Encoding
    • Payment Service API uses 8-bit Unicode Transformation Format as described in the ISO/ISE 10646. Merchants are required to send Service requests with content-type, “application/x-www-form-urlencoded”; and charset, “iso-8859-1,*, utf-8” using HTTP Post method.
  • Sales Transaction
    • Sales Transaction Parameters
      • The table below only includes typical parameters sent in a simple Authorization transaction request

  • Sales Transaction Request Examples

curl -X POST \
https://api.paybypinwheel.com/api/transaction/api \
-H ‘Content-Type: application/x-www-form-urlencoded’ \
-H ‘cache-control: no-cache’ \
-d ‘req_username=api%40zsandnoxz.test&req_password=ouNcbdp68KMNBVNDOkPJ&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022’

  • Sales Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

  •  Success Transaction Response Example

{“REQUEST_ACTION”: “CAPTURE”,
“TRANS_STATUS_NAME”: “APPROVED”,
“TRANS_VALUE”: “1.1200”,
“TRANS_REQUEST_ID”: 1272,
“TRANS_RECORD_ID”: 79154,
“TRANS_ORDER_ID”: 0980982o121,
“XTL_ORDER_ID”: “000011112222”,
“TRANS_CUR”: “USD”}

  • Refund Transaction

Merchants may request to refund the original sales transaction by sending CCCREDIT in the request_action parameter.

    • Refund Transaction Parameters

 

  •  Refund Transaction Request Examples

curl -X POST \
https://api.paybypinwheel.com/api/transaction/api \
-H ‘Content-Type: application/x-www-form-urlencoded’ \
-H ‘cache-control: no-cache’ \
-d ‘request_ref_po_id=186434737&request_action=CCCREDIT&amount=0.1&req_username=api%40zsandnoxz.test&req_password=ouNcbdp68KMNBVNDOkPJ’

  • Refund Transaction Success Response Fields

  • Refund Transaction Success Response Example

{“REQUEST_ACTION”: “REFUND”,
“TRANS_STATUS_NAME”: “APPROVED”,
“TRANS_VALUE”: “0.1000”,
“TRANS_REQUEST_ID”: 80282,
“TRANS_RECORD_ID”: 78443,
“TRANS_ORDER_ID”: 186434737,
“XTL_ORDER_ID”: “000011112222”,
“TRANS_CUR”: “USD”}

  • Declined Transaction Response Fields
    • These are the fields returned to the merchant when the transaction request has been declined on the Merchant Account Processor (bank) level: Send 5.02 as amount to test decline transaction

  •  Declined Transaction Response Example

curl -X POST \
https://api.paybypinwheel.com/api/transaction/api \
-H ‘Content-Type: application/x-www-form-urlencoded’ \
-H ‘cache-control: no-cache’ \
-d ‘request_ref_po_id=186434737&request_action=CCCREDIT&amount=0.1&req_username=api%40zsandnoxz.test&req_password=ouNcbdp68KMNBVNDOkPJ’

  •   Refund Declined Response Fields

These are the fields returned to the merchant when the refund request has been declined on the Merchant Account Processor (bank) level:

 

  • Declined Transaction Response Example

{“REQUEST_ACTION”: “REFUND”,
“TRANS_STATUS_NAME”: “DECLINED”,
“TRANS_VALUE”: “2.0000”,
“TRANS_REQUEST_ID”: 81489,
“TRANS_ORDER_ID”: 186435936,
“XTL_ORDER_ID”: “000011112222”,
“API_ADVICE”: “Requested refund amount is greater than Order amount balance! [OrderAmountBalance:1.02, RequestedRefundAmount:2]”,
“SERVICE_ADVICE”: “Requested refund amount is greater than Order amount balance! [OrderAmountBalance:1.02, RequestedRefundAmount:2]”,
“PROCESSOR_ADVICE”: “Requested refund amount is greater than Order amount balance! [OrderAmountBalance:1.02, RequestedRefundAmount:2]”,
“ERROR_MESSAGE”: “Requested refund amount is greater than Order amount balance! [OrderAmountBalance:1.02, RequestedRefundAmount:2]”,
“TRANS_CUR”: “USD”}