post https://apisandbox.onepay.com/transaction/
One of the following combinations is mandatory to be provided to initiate a transaction using OnePay Gateway API:
- Card number, expiration date, and security code (CVV)
- Track data
- Card token
Auth and Capture
An Authorization and Capture Transaction ensures that credit account is open, in good standing, and has sufficient funds to complete the submitted transaction.
Example Requests for Credit card auth capture:
{
"amount":"51.09",
"method":"CC",
"market_code": "E",
"type":"2",
"nonce":"12345645",
"test": "0",
"card":{
"number":"379605176666666",
"expiration_date":"0926"
},
"customer": {
"first_name": "Jhon",
"last_name": "salvatore",
"street_1": "2104 Floyd St NE",
"street_2": "Gilbert House",
"city": "Atlanta",
"state": "Chicago",
"zip": "21284",
"country": "USA",
"phone_number": "4754873567",
"company": "RRR",
"customer_id": "MCAC",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample"
}
}
{
"amount": "65.85",
"method": "CC",
"type": "2",
"nonce": "12345645",
"test": "0",
"client_ip": "",
"market_code": "R",
"notes": "",
"card": {
"track_data": "%B4005571701111111^FDMS TEST CARD/VISA^251210154321000000000000000 150 A?;4005571701111111=25121011000012345678?"
},
"Customer":
{
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
}
}
{
"market_code": "M",
"amount":"12.12",
"method":"CC",
"type":2,
"nonce":"12345645",
"client_ip": "106.51.74.202",
"card":{
"token":"d0c01f1595484b56a09da3d2f8451e1e"
},
"Customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"invoice_number": null,
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
}
}
{
"amount":"11.11",
"method":"ACH",
"type":"2",
"nonce":"12345645",
"test":"0",
"reference_transaction_id":"",
"client_ip":"172.26.15.177",
"device_code":"",
"market_code":"E",
"notes":"",
"check":{
"aba_code":"056008849",
"account_number":"3453543455",
"account_type":"Savings",
"bank_name":"ABC Bank",
"check_number":"1234567890",
"sec_code":"PPD",
"action_code":"1"
},
"Customer":
{
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
}
}
{
"amount": "32.10",
"method": "EBT",
"type": "2",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": {{$timestamp}},
"card": {
"track_data": "%B5053490000000016^Master/Test ^25041010000123000?;5053490000000016=25041010000000001230?",
"pin_block": "287C6AF5241FBA06",
"pin_ksn": "F876543210000A20008A"
}
}
{
"amount": "126.12",
"method": "DB",
"type": "2",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": "100115600010",
"card": {
"track_data": "%B5011180001111117^FDCS TEST CARD /MASTERCARD^251210110001111123456789012?;5011180001111117=2512101100000123456?",
"pin_block": "46E741B10819490D",
"pin_ksn": "F876543210000A20008D"
}
}
Example Response for Credit card auth capture:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209000",
"transaction_uid": "55dffb80-f64f-4a7f-8aee-b6f0c3f72cfa",
"transaction_datetime": "20230510T105133Z",
"account_type": "AX",
"account_last_4": "6666",
"amount": "51.09",
"approved_amount": "51.09",
"method": "CC",
"auth_code": "OK3461",
"avs_result_code": "Z",
"code_result": "",
"type": "2",
"expiration_date": "0926",
"token": "c1ffa1c21d334df6b65502a4b37ebe4f",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "Jhon",
"last_name": "salvatore",
"street_1": "2104 Floyd St NE",
"street_2": "Gilbert House",
"city": "Atlanta",
"state": "Chicago",
"zip": "21284",
"country": "USA",
"phone_number": "4754873567",
"company": "RRR",
"customer_id": "MCAC",
"email": "",
"email_receipt": "NO",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209018",
"transaction_uid": "0d509068-1a1b-4435-948d-8abf9ace9c80",
"transaction_datetime": "20230511T074235Z",
"account_type": "VI",
"account_last_4": "1111",
"amount": "65.85",
"approved_amount": "65.85",
"method": "CC",
"auth_code": "OK455C",
"avs_result_code": "",
"code_result": "",
"type": "2",
"expiration_date": "1225",
"token": "1867397598451111",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "NO",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "T",
"product_id": "K",
"prepaid_indicator": "P",
"detailcard_indicator": "M",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209024",
"transaction_uid": "e420c68c-94a7-4c03-8121-7badcf2fce40",
"transaction_datetime": "20230511T080629Z",
"account_type": "VI",
"account_last_4": "4652",
"amount": "12.12",
"approved_amount": "12.12",
"method": "CC",
"auth_code": "OK9071",
"avs_result_code": "Y",
"code_result": "",
"type": "2",
"expiration_date": "1125",
"token": "3d37c5750f514e3f9ebe44aad777b612",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer_response": {
"result_code": 1,
"result_text": "SUCCESS",
"result_sub_code": "2000",
"transaction_datetime": "20230511T080632Z",
"token": "3d37c5750f514e3f9ebe44aad777b612",
"account_type": "VI",
"account_last_4": "4652",
"expiration_date": "1125",
"first4": "4716"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "1000613",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209025",
"transaction_uid": "73b82ffe-7e12-4359-820d-1f86df060862",
"transaction_datetime": "20230511T080746Z",
"account_type": "Savings",
"account_last_4": "3455",
"amount": "11.11",
"approved_amount": "11.11",
"method": "ACH",
"auth_code": "",
"avs_result_code": "",
"code_result": "",
"type": "2",
"expiration_date": "",
"token": "3c648481490542e280459aa87f072f42",
"emv": "",
"emv_tag_data": "",
"entry_mode": ""
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209222",
"transaction_uid": "f125f7fc-1956-43ea-bddf-491233dd8e44",
"transaction_datetime": "20230512T092642Z",
"account_type": "EBT",
"account_last_4": "0016",
"amount": "32.10",
"approved_amount": "32.10",
"method": "EBT",
"auth_code": "000929",
"avs_result_code": "",
"code_result": "",
"type": "2",
"expiration_date": "0425",
"token": "47f3a88c46b245c8975322648d62e932",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "Test",
"last_name": "Master",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209223",
"transaction_uid": "6f1b70be-4e9e-4703-91a4-82007a010bab",
"transaction_datetime": "20230512T092901Z",
"account_type": "MC",
"account_last_4": "1117",
"amount": "126.12",
"approved_amount": "126.12",
"method": "DB",
"auth_code": "001027",
"avs_result_code": "",
"code_result": "",
"type": "2",
"expiration_date": "1225",
"token": "13df4008ba4840c592fdb058fc0536f3",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "MASTERCARD",
"last_name": "FDCS TEST CARD",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "P",
"debitnetwork_indicator": "68P43P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00"
}
}
Auth Only
An Authorization Only transaction, also known as Auth Only transaction, is a payment processing transaction that holds funds from a customer's account for settlement at a later date. In this type of transaction, the funds are not immediately deducted from the customer's account but are put on hold or reserved for the specific transaction.
Example Request:
{
"market_code": "E",
"amount":"10.50",
"method":"CC",
"type":"1",
"nonce":"12345645",
"client_ip": "",
"test": "0",
"card":{
"number":"379605176666666",
"expiration_date":"0926"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"invoice_number": null,
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
}
}
{
"market_code": "M",
"amount":"10.50",
"method":"CC",
"type":"1",
"nonce":"12345645",
"client_ip": "",
"test": "0",
"card":{
"track_data": "%B4005571701111111^FDMS TEST CARD/VISA^251210154321000000000000000 150 A?;4005571701111111=25121011000012345678?"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"invoice_number": null,
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
}
}
{
"market_code": "M",
"amount":"12.12",
"method":"CC",
"type":2,
"nonce":"12345645",
"client_ip": "106.51.74.202",
"card":{
"token":"73210ed97edf404883823dc6e37107a1"
},
"Customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"invoice_number": null,
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
}
}
{
"amount": "32.10",
"method": "EBT",
"type": "1",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": "",
"card": {
"track_data": "%B5053490000000016^Master/Test ^25041010000123000?;5053490000000016=25041010000000001230?",
"pin_block": "287C6AF5241FBA06",
"pin_ksn": "F876543210000A20008A"
},
"Customer":
{
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
}
}
{
"amount": "126.12",
"method": "DB",
"type": "1",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": "100115600010",
"card": {
"track_data": "%B5011180001111117^FDCS TEST CARD /MASTERCARD^251210110001111123456789012?;5011180001111117=2512101100000123456?",
"pin_block": "46E741B10819490D",
"pin_ksn": "F876543210000A20008D"
}
}
Example Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19208283",
"transaction_uid": "3ce8f6e9-46a5-41d9-bfb8-912d2114860b",
"transaction_datetime": "20230511T091148Z",
"account_type": "AX",
"account_last_4": "6666",
"amount": "51.09",
"approved_amount": "51.09",
"method": "CC",
"auth_code": "OK0001",
"avs_result_code": "",
"code_result": "",
"type": "1",
"expiration_date": "0926",
"token": "1e36dc5bb92840eb81ae69163a3d31b1",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "NO",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19208284",
"transaction_uid": "f5e69df5-4e5f-44c0-8d34-e475b50b82bc",
"transaction_datetime": "20230511T091314Z",
"account_type": "VI",
"account_last_4": "1111",
"amount": "10.50",
"approved_amount": "10.50",
"method": "CC",
"auth_code": "OK013C",
"avs_result_code": "Y",
"code_result": "",
"type": "1",
"expiration_date": "1225",
"token": "782093693391111",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "AUTO",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": ""
},
"card_info": {
"card_class": "T",
"product_id": "K",
"prepaid_indicator": "P",
"detailcard_indicator": "M",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209030",
"transaction_uid": "5e517787-028e-46ef-a754-e94659b66d19",
"transaction_datetime": "20230511T091652Z",
"account_type": "VI",
"account_last_4": "3884",
"amount": "12.12",
"approved_amount": "12.12",
"method": "CC",
"auth_code": "OK0781",
"avs_result_code": "Y",
"code_result": "",
"type": "2",
"expiration_date": "1125",
"token": "d0c01f1595484b56a09da3d2f8451e1e",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer_response": {
"result_code": 1,
"result_text": "SUCCESS",
"result_sub_code": "2000",
"transaction_datetime": "20230511T091656Z",
"token": "d0c01f1595484b56a09da3d2f8451e1e",
"account_type": "VI",
"account_last_4": "3884",
"expiration_date": "1125",
"first4": "4024"
},
"customer": {
"first_name": "Oscar",
"last_name": "Brady",
"street_1": "55",
"street_2": "Airport Drive",
"city": "Pensacola",
"state": "FL",
"zip": "32503",
"country": "US",
"phone_number": "2025550197",
"company": "Ferry Group",
"customer_id": "1000614",
"email": "[email protected]",
"email_receipt": "YES",
"notes": "Sample Test ",
"action_code": "1"
},
"card_info": {
"card_class": "C",
"product_id": "A",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209228",
"transaction_uid": "5a7f5392-bc02-4ad8-b41b-81f54ae7a776",
"transaction_datetime": "20230512T093754Z",
"account_type": "EBT",
"account_last_4": "0016",
"amount": "32.10",
"approved_amount": "32.10",
"method": "EBT",
"auth_code": "002096",
"avs_result_code": "",
"code_result": "",
"type": "1",
"expiration_date": "0425",
"token": "82070ed2af104234be567f8e0a6f365e",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "Test",
"last_name": "Master",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209231",
"transaction_uid": "4eddbf76-26d2-4565-9eab-928c6caf489a",
"transaction_datetime": "20230512T094238Z",
"account_type": "MC",
"account_last_4": "1117",
"amount": "126.12",
"approved_amount": "126.12",
"method": "DB",
"auth_code": "002827",
"avs_result_code": "",
"code_result": "",
"type": "1",
"expiration_date": "1225",
"token": "13df4008ba4840c592fdb058fc0536f3",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "MASTERCARD",
"last_name": "FDCS TEST CARD",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "P",
"debitnetwork_indicator": "68P43P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00"
}
}
Prior Auth Capture
The Prior Authorization Capture transaction method is used to capture funds that were previously authorized or held through an Authorization Only transaction. This transaction method is typically used when the merchant is ready to finalize the payment and transfer the held funds from the customer's account to their own account.
Prior Auth Capture can be performed using the transaction ID or nonce of parent auth only transaction.
Example Request:
{
"type":"3",
"method":"CC",
"nonce":"12345645",
"reference_transaction_id":"1033408",
"amount":"15.06",
"card":{
"number":"2538"
}
}
{
"type":"3",
"method":"CC",
"nonce":"1683796931",
"amount":"59.09",
"card":{
"number":"6666"
},
"customer": {
"first_name": "Roshna",
"last_name": "",
"street_1": "8320",
"street_2": "",
"city": "",
"state": "",
"zip": "85284",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "NO",
"notes": "",
"sms_receipt": 0
}
}
{
"type":"3",
"method":"DB",
"nonce":"12345645",
"reference_transaction_id":"19209263",
"amount":"126.12",
"card":{
"number":"1117"
}
}
{
"type":"3",
"method":"EBT",
"nonce":"12345645",
"reference_transaction_id":"19209275",
"amount":"32.10",
"card":{
"number":"0016"
}
}
Example Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209031",
"transaction_uid": "076f0db0-6ee9-4411-9f29-bc27150ea2d2",
"transaction_datetime": "20230511T091837Z",
"account_type": "AX",
"account_last_4": "6666",
"amount": "51.09",
"approved_amount": "51.09",
"method": "CC",
"auth_code": "OK0901",
"avs_result_code": " ",
"code_result": " ",
"type": "3",
"expiration_date": "0926",
"token": "8f9f5aab58274e9793d87a43a4dc79a8",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "1683796726",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209033",
"transaction_uid": "85df368e-a6cb-4ad4-a0a0-eb2784f84524",
"transaction_datetime": "20230511T092212Z",
"account_type": "AX",
"account_last_4": "0018",
"amount": "59.09",
"approved_amount": "59.09",
"method": "CC",
"auth_code": "OK1151",
"avs_result_code": "Y",
"code_result": " ",
"type": "3",
"expiration_date": "1023",
"token": "2cbb06a876454a42b37db3d205cf949c",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "1683796931",
"test": "0",
"customer": {
"first_name": "Roshna",
"last_name": "",
"street_1": "8320",
"street_2": "",
"city": "",
"state": "",
"zip": "85284",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "NO",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209263",
"transaction_uid": "4eddbf76-26d2-4565-9eab-928c6caf489a",
"transaction_datetime": "20230512T095932Z",
"account_type": "MC",
"account_last_4": "1117",
"amount": "126.12",
"approved_amount": "126.12",
"method": "DB",
"auth_code": "002827",
"avs_result_code": " ",
"code_result": " ",
"type": "3",
"expiration_date": "1225",
"token": "13df4008ba4840c592fdb058fc0536f3",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "P",
"debitnetwork_indicator": "68P43P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00"
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209275",
"transaction_uid": "3f8b5f3b-5c9b-4715-b5e3-5e1c35ee32cf",
"transaction_datetime": "20230512T101043Z",
"account_type": "EBT",
"account_last_4": "0016",
"amount": "32.10",
"approved_amount": "32.10",
"method": "EBT",
"auth_code": "002665",
"avs_result_code": " ",
"code_result": " ",
"type": "3",
"expiration_date": "0425",
"token": "82070ed2af104234be567f8e0a6f365e",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
Capture Only
For settling a transaction that was not submitted for authorization through the payment gateway, you need to send a request with an authorization code. The AuthCode field is mandatory for this type of transaction as it provides the authorization code associated with the transaction.
Sample Request:
{
"amount": "32.30",
"method": "EBT",
"type": "4",
"nonce": "12345645",
"test": "0",
"market_code": "E",
"notes": "100039850010",
"card": {
"number": "5053490000000016",
"expiration_date": "0424",
"auth_code": "123456",
"voucher_number": "1234567"
}
}
Sample Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209373",
"transaction_uid": "50f7e245-0ebb-4f84-a91b-697d587839b9",
"transaction_datetime": "20230512T103113Z",
"account_type": "EBT",
"account_last_4": "0016",
"amount": "32.30",
"approved_amount": "32.30",
"method": "EBT",
"auth_code": "312382",
"avs_result_code": "",
"code_result": "",
"type": "4",
"expiration_date": "0424",
"token": "ccbc3aabd25845f1bc7a9883b0ca4871",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
Verification Transaction
The Verification Method is a transaction request sent to verify the credit card details of the cardholder. It is typically a $0 transaction that is not intended to charge the cardholder but to validate the card's authenticity and confirm that it is in good standing.
Example Request:
{
"amount":"0.00",
"method":"CC",
"type":"9",
"nonce":"12345645",
"card":{
"number":"379605176666666",
"expiration_date":"0421"
}
}
{
"amount":"0.00",
"method":"CC",
"type":"9",
"nonce":"12345645",
"card":{
"track_data": "%B4005571701111111^FDMS TEST CARD/VISA^251210154321000000000000000 150 A?;4005571701111111=25121011000012345678?"
}
}
Example Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "00",
"result_text": "APPROVED",
"transaction_id": "19209034",
"transaction_uid": "a89c8ca4-433a-4bb4-b953-11f967d83dac",
"transaction_datetime": "20230511T092624Z",
"account_type": "AX",
"account_last_4": "6666",
"amount": "0",
"approved_amount": "0",
"method": "CC",
"auth_code": "AXS756",
"avs_result_code": "",
"code_result": "",
"type": "9",
"expiration_date": "0426",
"token": "d3ada86a241f4d55bff659f4403d907b",
"emv": "",
"emv_tag_data": "",
"entry_mode": "01"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "X",
"debitnetwork_indicator": ""
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "85",
"result_text": "OK",
"transaction_id": "19209035",
"transaction_uid": "01d522cc-5d6a-4cdf-a753-e904f52b438a",
"transaction_datetime": "20230511T092728Z",
"account_type": "VI",
"account_last_4": "1111",
"amount": "0.00",
"approved_amount": "0.00",
"method": "CC",
"auth_code": "PREATH",
"avs_result_code": "",
"code_result": "",
"type": "9",
"expiration_date": "1225",
"token": "7892a4faf9d94803ab0d02ceb533087d",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "T",
"product_id": "K",
"prepaid_indicator": "P",
"detailcard_indicator": "M",
"debitnetwork_indicator": ""
}
}
Balance Inquiry
The method used to check the amount remaining on a customer's card is typically referred to as a balance inquiry or balance check. By initiating a balance inquiry, you can retrieve the current balance or available funds on a customer's card.
Sample Request:
{
"amount": "0.0",
"method": "EBT",
"type": "11",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": "100037310010",
"card": {
"track_data": "%B5053490000000115^FDCS TEST CARD /MASTERCARD^25121010001111123456789012?;5053490000000115=2512101100000123456?",
"pin_block": "74D78DAD0F1BED06",
"PIN_KSN": "F876543210000A20008F"
}
}
{
"amount": "0.0",
"method": "DB",
"type": "11",
"nonce": "12345645",
"test": "0",
"client_ip": "172.26.15.177",
"market_code": "R",
"notes": "100037290010",
"card": {
"track_data": "%B4017779995555556^FDMS TEST CARD /VISA^251210154321000000000000000150?;4017779995555556=25121011000012345678?",
"pin_block": "08CC138825FDB724",
"pin_ksn": "F876543210000A200090"
}
}
Sample Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209387",
"transaction_uid": "b95b07bb-7109-4312-b407-230d764b34b1",
"transaction_datetime": "20230512T130540Z",
"account_type": "EBT",
"account_last_4": "0115",
"amount": "0.00",
"approved_amount": "100.00",
"method": "EBT",
"auth_code": "000944",
"avs_result_code": "",
"code_result": "",
"type": "11",
"expiration_date": "",
"token": "e228bb4e628d40c295fdde4f59c4eb3f",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "MASTERCARD",
"last_name": "FDCS TEST CARD",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209389",
"transaction_uid": "6ecac6e6-f5e3-42a9-9ea7-9e91f64957e5",
"transaction_datetime": "20230512T130814Z",
"account_type": "VI",
"account_last_4": "5556",
"amount": "0.00",
"approved_amount": "100.00",
"method": "DB",
"auth_code": "001250",
"avs_result_code": "",
"code_result": "",
"type": "11",
"expiration_date": "",
"token": "a537ea32d34d44cd94f96cb602e5cb27",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "VISA",
"last_name": "FDMS TEST CARD",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "C",
"product_id": "F",
"prepaid_indicator": "",
"detailcard_indicator": "H",
"debitnetwork_indicator": "25P30P15P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00"
}
}
API Explorer
To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response
Try the sample requests which will hit to our Onepay sandbox environment by changing the transaction type and card data. Refer API Explorer for more details.