Pay InTransactions

Make a sale transaction

Learn how to authorize and capture a sales transaction in one step using the API
Applies to:Developers

This guide explains how to make a sale (a money in payment transaction) with the Payabli API. This method authorizes and captures a payment in one step, so when a transaction is submitted, it’s immediately captured for settlement.

If aren’t using a stored payment method provided by an embedded component to run transactions, you must secure cardholder, bank account data, and customer IP address because your PCI scope is expanded.

To make a sale transaction, send a POST request to the getpaid endpoint (api/v2/MoneyIn/getpaid or /api/MoneyIn/getpaid). These endpoints are used to process payments for all payment methods, including credit cards, ACH, stored methods, cash, check, and cloud payments.

See Pay In transaction APIs v2 for more information about v1 versus v2 of the transaction APIs.

The request requires several parameters, which can depend on the payment method used. The following are required for all payment methods:

  • entryPoint The ID of the paypoint making the sale
  • paymentMethod: Information about the payment method
  • paymentDetails Information about the payment itself
  • customerData Information about the customer

Although not required, we strongly recommend passing the ipaddress parameter. This is used for risk analysis and fraud prevention.

For a full list of available parameters, see the API references.

Examples

Each of these examples runs a transaction for $100, with no service fee, for entrypoint f743aed24a and customer ID is 4440.The only difference in each example is the payment method used.

V2 API

If you’re using the v2 API, here are examples for making a sale transaction with different payment methods:

The Card payment method is used for credit and debit card payments.

POST
/api/v2/MoneyIn/getpaid
1curl -X POST https://api-sandbox.payabli.com/api/v2/MoneyIn/getpaid \
2     -H "requestToken: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "paymentDetails": {
6    "totalAmount": 100,
7    "serviceFee": 0
8  },
9  "paymentMethod": {
10    "cardcvv": "999",
11    "cardexp": "02/27",
12    "cardHolder": "John Cassian",
13    "cardnumber": "4111111111111111",
14    "cardzip": "12345",
15    "initiator": "payor",
16    "method": "card"
17  },
18  "customerData": {
19    "customerId": 4440
20  },
21  "entryPoint": "f743aed24a",
22  "ipaddress": "255.255.255.255"
23}'

The ACH payment method is used for ACH payments made with a bank account.

POST
/api/v2/MoneyIn/getpaid
1curl -X POST https://api-sandbox.payabli.com/api/v2/MoneyIn/getpaid \
2     -H "requestToken: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "paymentDetails": {
6    "totalAmount": 100,
7    "serviceFee": 0
8  },
9  "paymentMethod": {
10    "achAccount": "123123123",
11    "achAccountType": "Checking",
12    "achCode": "WEB",
13    "achHolder": "John Cassian",
14    "achHolderType": "personal",
15    "achRouting": "123123123",
16    "method": "ach"
17  },
18  "customerData": {
19    "customerId": 4440
20  },
21  "entryPoint": "f743aed24a",
22  "ipaddress": "255.255.255.255"
23}'

The Stored Method payment method is used for payments made with stored methods, either tokenized credit card or tokenized ACH account.

POST
/api/v2/MoneyIn/getpaid
1curl -X POST https://api-sandbox.payabli.com/api/v2/MoneyIn/getpaid \
2     -H "requestToken: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "paymentDetails": {
6    "totalAmount": 100,
7    "serviceFee": 0
8  },
9  "paymentMethod": {
10    "initiator": "payor",
11    "method": "card",
12    "storedMethodId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
13    "storedMethodUsageType": "unscheduled"
14  },
15  "customerData": {
16    "customerId": 4440
17  },
18  "entryPoint": "f743aed24a",
19  "ipaddress": "255.255.255.255"
20}'

The Cloud payment method is used for payments made with Cloud devices (payment terminals).

POST
/api/v2/MoneyIn/getpaid
1curl -X POST https://api-sandbox.payabli.com/api/v2/MoneyIn/getpaid \
2     -H "requestToken: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "paymentDetails": {
6    "totalAmount": 100,
7    "serviceFee": 0
8  },
9  "paymentMethod": {
10    "device": "6c361c7d-674c-44cc-b790-382b75d1xxx",
11    "method": "cloud",
12    "saveIfSuccess": true
13  },
14  "customerData": {
15    "customerId": 4440
16  },
17  "entryPoint": "f743aed24a",
18  "ipaddress": "255.255.255.255"
19}'

The response from a successful transaction includes a standard response structure with details about the transaction. See Unified Response Codes for a complete list of possible responses.

Example card success response

Response
1{
2  "code": "A0000",
3  "reason": "Approved",
4  "explanation": "Transaction approved",
5  "action": "No action required",
6  "data": {
7    "parentOrgName": "Mrinal's Pet Supplies",
8    "paypointDbaname": "Mrinal's Pet Shop North",
9    "paypointLegalname": "Mrinal's Pet Shop North",
10    "paypointEntryname": "495147f647",
11    "paymentTransId": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae",
12    "connectorName": "gp",
13    "externalProcessorInformation": "",
14    "gatewayTransId": "TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB",
15    "orderId": null,
16    "method": "card",
17    "batchNumber": "3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49",
18    "batchAmount": 420,
19    "payorId": 40144,
20    "paymentData": {
21      "maskedAccount": "4XXXXXXXXXXX5439",
22      "accountType": "visa",
23      "accountExp": "12/25",
24      "holderName": "John Cassian",
25      "storedId": null,
26      "initiator": null,
27      "storedMethodUsageType": null,
28      "sequence": null,
29      "orderDescription": "",
30      "accountId": null,
31      "signatureData": null,
32      "binData": {
33        "binMatchedLength": "6",
34        "binCardBrand": "VISA",
35        "binCardType": "CREDIT",
36        "binCardCategory": "CLASSIC",
37        "binCardIssuer": "",
38        "binCardIssuerCountry": "RUSSIAN FEDERATION",
39        "binCardIssuerCountryCodeA2": "RU",
40        "binCardIssuerCountryNumber": "643",
41        "binCardIsRegulated": "",
42        "binCardUseCategory": "",
43        "binCardIssuerCountryCodeA3": ""
44      },
45      "paymentDetails": {
46        "totalAmount": 105,
47        "serviceFee": 5,
48        "checkNumber": null,
49        "checkImage": null,
50        "checkUniqueId": "",
51        "currency": "USD",
52        "orderDescription": null,
53        "orderId": null,
54        "orderIdAlternative": null,
55        "paymentDescription": null,
56        "groupNumber": null,
57        "source": null,
58        "payabliTransId": null,
59        "unbundled": null,
60        "categories": [],
61        "splitFunding": []
62      }
63    },
64    "transStatus": 1,
65    "paypointId": 3040,
66    "totalAmount": 105,
67    "netAmount": 100,
68    "feeAmount": 5,
69    "settlementStatus": 0,
70    "operation": "Sale",
71    "responseData": {
72      "resultCode": "A0000",
73      "resultCodeText": "Approved",
74      "response": null,
75      "responsetext": "CAPTURED",
76      "authcode": "AXS425",
77      "transactionid": "TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I",
78      "avsresponse": "N",
79      "avsresponse_text": "No Match, No address or ZIP match",
80      "cvvresponse": "M",
81      "cvvresponse_text": "CVV2/CVC2 match",
82      "orderid": null,
83      "response_code": "100",
84      "response_code_text": "Operation successful",
85      "customer_vault_id": null,
86      "emv_auth_response_data": null,
87      "type": null
88    },
89    "source": "api",
90    "scheduleReference": 0,
91    "orgId": 17448,
92    "refundId": 0,
93    "returnedId": 0,
94    "chargebackId": 0,
95    "retrievalId": 0,
96    "transAdditionalData": null,
97    "invoiceData": {
98      "invoiceNumber": null,
99      "invoiceStatus": null,
100      "invoiceType": null,
101      "frequency": null,
102      "paymentTerms": null,
103      "termsConditions": null,
104      "notes": null,
105      "invoiceAmount": null,
106      "purchaseOrder": null,
107      "firstName": null,
108      "lastName": null,
109      "company": null,
110      "shippingAddress1": null,
111      "shippingAddress2": null,
112      "shippingCity": null,
113      "shippingState": null,
114      "shippingZip": null,
115      "shippingCountry": null,
116      "shippingEmail": null,
117      "shippingPhone": null,
118      "shippingFromZip": null,
119      "summaryCommodityCode": null,
120      "items": null,
121      "additionalData": null,
122      "invoiceDate": null,
123      "invoiceDueDate": null,
124      "invoiceEndDate": null,
125      "tax": null,
126      "discount": null,
127      "freightAmount": null,
128      "dutyAmount": null,
129      "attachments": null
130    },
131    "entrypageId": 0,
132    "externalPaypointID": "",
133    "isValidatedACH": false,
134    "transactionTime": "2025-12-01T09:50:03.559",
135    "customer": {
136      "identifiers": null,
137      "firstName": "David",
138      "lastName": "Beckham",
139      "companyName": "Driving School LLC",
140      "billingAddress1": "Home Address",
141      "billingAddress2": "",
142      "billingCity": "",
143      "billingState": "",
144      "billingZip": "45157",
145      "billingCountry": "US",
146      "billingPhone": "+15555555555",
147      "billingEmail": "mrinal.kundu@payabli.com",
148      "customerNumber": "C-90010",
149      "shippingAddress1": "Home Address",
150      "shippingAddress2": "",
151      "shippingCity": "",
152      "shippingState": "",
153      "shippingZip": "45157",
154      "shippingCountry": "US",
155      "customerId": 40144,
156      "customerStatus": 0,
157      "additionalData": null
158    },
159    "cfeeTransactions": [
160      {
161        "cFeeTransid": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae",
162        "feeAmount": 5,
163        "operation": "Sale",
164        "refundId": 0,
165        "responseData": {},
166        "settlementStatus": 0,
167        "transactionTime": "2025-12-01T09:50:03.559",
168        "transStatus": 1
169      }
170    ],
171    "transactionEvents": [
172      {
173        "transEvent": "Created",
174        "eventData": "0HNHD68HATSUC:00000001",
175        "eventTime": "2025-12-01T09:50:02.558651"
176      },
177      {
178        "transEvent": "Approved",
179        "eventData": "0HNHD68HATSUC:00000001",
180        "eventTime": "2025-12-01T09:50:03.609111"
181      }
182    ],
183    "riskStatus": "PASSED",
184    "riskReason": "",
185    "riskAction": "",
186    "deviceId": "",
187    "achSecCode": "",
188    "achHolderType": "personal",
189    "ipAddress": "255.255.255.255",
190    "isSameDayACH": false,
191    "walletType": null,
192    "splitFundingInstructions": null,
193    "pendingFeeAmount": 0,
194    "riskFlagged": false,
195    "riskFlaggedOn": "2025-12-01T09:50:02.5474568",
196    "riskActionCode": 0
197  },
198  "token": null
199}

Example ACH success response

Response
1{
2  "code": "A0000",
3  "reason": "Approved",
4  "explanation": "Transaction approved",
5  "action": "No action required",
6  "data": {
7    "parentOrgName": "Mountain View Services",
8    "paypointDbaname": "Mountain View Auto",
9    "paypointLegalname": "Mountain View Automotive Services LLC",
10    "paypointEntryname": "31ae451b89",
11    "paymentTransId": "2145-7b8fa3c9d5e64f73b2ee5a6b14bd39cd",
12    "connectorName": "checkcommerce",
13    "externalProcessorInformation": "",
14    "gatewayTransId": "ACH_TRN_8K92D7VZexp8PFR3RGYbu2zRTMG3oC",
15    "orderId": null,
16    "method": "ach",
17    "batchNumber": "checkcommerce_2145_ach_12-01-2025",
18    "batchAmount": 525,
19    "payorId": 38267,
20    "paymentData": {
21      "maskedAccount": "XXXXX4532",
22      "accountType": "Checking",
23      "accountExp": null,
24      "holderName": "Sarah Martinez",
25      "storedId": null,
26      "initiator": null,
27      "storedMethodUsageType": null,
28      "sequence": null,
29      "orderDescription": "",
30      "accountId": null,
31      "signatureData": null,
32      "binData": null,
33      "paymentDetails": {
34        "totalAmount": 105,
35        "serviceFee": 5,
36        "checkNumber": null,
37        "checkImage": null,
38        "checkUniqueId": "",
39        "currency": "USD",
40        "orderDescription": null,
41        "orderId": null,
42        "orderIdAlternative": null,
43        "paymentDescription": null,
44        "groupNumber": null,
45        "source": null,
46        "payabliTransId": null,
47        "unbundled": null,
48        "categories": [],
49        "splitFunding": []
50      }
51    },
52    "transStatus": 1,
53    "paypointId": 2145,
54    "totalAmount": 105,
55    "netAmount": 100,
56    "feeAmount": 5,
57    "settlementStatus": 0,
58    "operation": "Sale",
59    "responseData": {
60      "resultCode": "A0000",
61      "resultCodeText": "Approved",
62      "response": null,
63      "responsetext": "CAPTURED",
64      "authcode": "AXS425",
65      "transactionid": "TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I",
66      "avsresponse": "N",
67      "avsresponse_text": "No Match, No address or ZIP match",
68      "cvvresponse": "M",
69      "cvvresponse_text": "CVV2/CVC2 match",
70      "orderid": null,
71      "response_code": "100",
72      "response_code_text": "Operation successful",
73      "customer_vault_id": null,
74      "emv_auth_response_data": null,
75      "type": null
76    },
77    "source": "api",
78    "scheduleReference": 0,
79    "orgId": 14267,
80    "refundId": 0,
81    "returnedId": 0,
82    "chargebackId": 0,
83    "retrievalId": 0,
84    "transAdditionalData": null,
85    "invoiceData": {
86      "invoiceNumber": null,
87      "invoiceStatus": null,
88      "invoiceType": null,
89      "frequency": null,
90      "paymentTerms": null,
91      "termsConditions": null,
92      "notes": null,
93      "invoiceAmount": null,
94      "purchaseOrder": null,
95      "firstName": null,
96      "lastName": null,
97      "company": null,
98      "shippingAddress1": null,
99      "shippingAddress2": null,
100      "shippingCity": null,
101      "shippingState": null,
102      "shippingZip": null,
103      "shippingCountry": null,
104      "shippingEmail": null,
105      "shippingPhone": null,
106      "shippingFromZip": null,
107      "summaryCommodityCode": null,
108      "items": null,
109      "additionalData": null,
110      "invoiceDate": null,
111      "invoiceDueDate": null,
112      "invoiceEndDate": null,
113      "tax": null,
114      "discount": null,
115      "freightAmount": null,
116      "dutyAmount": null,
117      "attachments": null
118    },
119    "entrypageId": 0,
120    "externalPaypointID": "",
121    "isValidatedACH": true,
122    "transactionTime": "2025-12-01T10:15:28.742",
123    "customer": {
124      "identifiers": null,
125      "firstName": "Sarah",
126      "lastName": "Martinez",
127      "companyName": "Martinez Consulting",
128      "billingAddress1": "456 Oak Avenue",
129      "billingAddress2": "Suite 201",
130      "billingCity": "Portland",
131      "billingState": "OR",
132      "billingZip": "97201",
133      "billingCountry": "US",
134      "billingPhone": "+15035551234",
135      "billingEmail": "sarah.martinez@example.com",
136      "customerNumber": "C-80245",
137      "shippingAddress1": "456 Oak Avenue",
138      "shippingAddress2": "Suite 201",
139      "shippingCity": "Portland",
140      "shippingState": "OR",
141      "shippingZip": "97201",
142      "shippingCountry": "US",
143      "customerId": 38267,
144      "customerStatus": 0,
145      "additionalData": null
146    },
147    "cfeeTransactions": [
148      {
149        "cFeeTransid": "2145-7b8fa3c9d5e64f73b2ee5a6b14bd39cd",
150        "feeAmount": 5,
151        "operation": "Sale",
152        "refundId": 0,
153        "responseData": {},
154        "settlementStatus": 0,
155        "transactionTime": "2025-12-01T10:15:28.742",
156        "transStatus": 1
157      }
158    ],
159    "transactionEvents": [
160      {
161        "transEvent": "Created",
162        "eventData": "0HNHD69JBVWXP:00000001",
163        "eventTime": "2025-12-01T10:15:27.682442"
164      },
165      {
166        "transEvent": "Approved",
167        "eventData": "0HNHD69JBVWXP:00000001",
168        "eventTime": "2025-12-01T10:15:28.751283"
169      }
170    ],
171    "riskStatus": "PASSED",
172    "riskReason": "",
173    "riskAction": "",
174    "deviceId": "",
175    "achSecCode": "WEB",
176    "achHolderType": "personal",
177    "ipAddress": "255.255.255.255",
178    "isSameDayACH": false,
179    "walletType": null,
180    "splitFundingInstructions": null,
181    "pendingFeeAmount": 0,
182    "riskFlagged": false,
183    "riskFlaggedOn": "2025-12-01T10:15:27.6712346",
184    "riskActionCode": 0
185  },
186  "token": null
187}

Example Stored Method success response

Response
1{
2  "code": "A0000",
3  "reason": "Approved",
4  "explanation": "Transaction approved",
5  "action": "No action required",
6  "data": {
7    "parentOrgName": "Mrinal's Pet Supplies",
8    "paypointDbaname": "Mrinal's Pet Shop North",
9    "paypointLegalname": "Mrinal's Pet Shop North",
10    "paypointEntryname": "495147f647",
11    "paymentTransId": "3040-9708542b00354726ad8a6b0c65bc7a54",
12    "connectorName": "gp",
13    "externalProcessorInformation": "",
14    "gatewayTransId": "TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I",
15    "orderId": null,
16    "method": "card",
17    "batchNumber": "3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49",
18    "batchAmount": 630,
19    "payorId": 40144,
20    "paymentData": {
21      "maskedAccount": "3XXXXXXXXXX0227",
22      "accountType": "amex",
23      "accountExp": "12/25",
24      "holderName": "Alexa Amazon",
25      "storedId": "fb1f5ec2-1ba4-4ba6-9839-20c2cc4baf5a-40144",
26      "initiator": "merchant",
27      "storedMethodUsageType": "unscheduled",
28      "sequence": "subsequent",
29      "orderDescription": "",
30      "accountId": null,
31      "signatureData": null,
32      "binData": {
33        "binMatchedLength": "",
34        "binCardBrand": "",
35        "binCardType": "",
36        "binCardCategory": "",
37        "binCardIssuer": "",
38        "binCardIssuerCountry": "",
39        "binCardIssuerCountryCodeA2": "",
40        "binCardIssuerCountryNumber": "",
41        "binCardIsRegulated": "",
42        "binCardUseCategory": "",
43        "binCardIssuerCountryCodeA3": ""
44      },
45      "paymentDetails": {
46        "totalAmount": 105,
47        "serviceFee": 5,
48        "checkNumber": null,
49        "checkImage": null,
50        "checkUniqueId": "",
51        "currency": "USD",
52        "orderDescription": null,
53        "orderId": null,
54        "orderIdAlternative": null,
55        "paymentDescription": null,
56        "groupNumber": null,
57        "source": null,
58        "payabliTransId": null,
59        "unbundled": null,
60        "categories": [],
61        "splitFunding": []
62      }
63    },
64    "transStatus": 1,
65    "paypointId": 3040,
66    "totalAmount": 105,
67    "netAmount": 100,
68    "feeAmount": 5,
69    "settlementStatus": 0,
70    "operation": "Sale",
71    "responseData": {
72      "resultCode": "A0000",
73      "resultCodeText": "Approved",
74      "response": null,
75      "responsetext": "CAPTURED",
76      "authcode": "AXS425",
77      "transactionid": "TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I",
78      "avsresponse": "N",
79      "avsresponse_text": "No Match, No address or ZIP match",
80      "cvvresponse": "M",
81      "cvvresponse_text": "CVV2/CVC2 match",
82      "orderid": null,
83      "response_code": "100",
84      "response_code_text": "Operation successful",
85      "customer_vault_id": null,
86      "emv_auth_response_data": null,
87      "type": null
88    },
89    "source": "api",
90    "scheduleReference": 0,
91    "orgId": 17448,
92    "refundId": 0,
93    "returnedId": 0,
94    "chargebackId": 0,
95    "retrievalId": 0,
96    "transAdditionalData": null,
97    "invoiceData": {
98      "invoiceNumber": null,
99      "invoiceStatus": null,
100      "invoiceType": null,
101      "frequency": null,
102      "paymentTerms": null,
103      "termsConditions": null,
104      "notes": null,
105      "invoiceAmount": null,
106      "purchaseOrder": null,
107      "firstName": null,
108      "lastName": null,
109      "company": null,
110      "shippingAddress1": null,
111      "shippingAddress2": null,
112      "shippingCity": null,
113      "shippingState": null,
114      "shippingZip": null,
115      "shippingCountry": null,
116      "shippingEmail": null,
117      "shippingPhone": null,
118      "shippingFromZip": null,
119      "summaryCommodityCode": null,
120      "items": null,
121      "additionalData": null,
122      "invoiceDate": null,
123      "invoiceDueDate": null,
124      "invoiceEndDate": null,
125      "tax": null,
126      "discount": null,
127      "freightAmount": null,
128      "dutyAmount": null,
129      "attachments": null
130    },
131    "entrypageId": 0,
132    "externalPaypointID": "",
133    "isValidatedACH": false,
134    "transactionTime": "2025-12-01T09:56:33.967",
135    "customer": {
136      "identifiers": null,
137      "firstName": "David",
138      "lastName": "Beckham",
139      "companyName": "Driving School LLC",
140      "billingAddress1": "Home Address",
141      "billingAddress2": "",
142      "billingCity": "",
143      "billingState": "",
144      "billingZip": "45157",
145      "billingCountry": "US",
146      "billingPhone": "+15555555555",
147      "billingEmail": "mrinal.kundu@payabli.com",
148      "customerNumber": "C-90010",
149      "shippingAddress1": "Home Address",
150      "shippingAddress2": "",
151      "shippingCity": "",
152      "shippingState": "",
153      "shippingZip": "45157",
154      "shippingCountry": "US",
155      "customerId": 40144,
156      "customerStatus": 0,
157      "additionalData": null
158    },
159    "cfeeTransactions": [
160      {
161        "cFeeTransid": "3040-9708542b00354726ad8a6b0c65bc7a54",
162        "feeAmount": 5,
163        "operation": "Sale",
164        "refundId": 0,
165        "responseData": {},
166        "settlementStatus": 0,
167        "transactionTime": "2025-12-01T09:56:33.967",
168        "transStatus": 1
169      }
170    ],
171    "transactionEvents": [
172      {
173        "transEvent": "Created",
174        "eventData": "0HNHD68HATSUR:00000004",
175        "eventTime": "2025-12-01T09:56:32.662988"
176      },
177      {
178        "transEvent": "Approved",
179        "eventData": "0HNHD68HATSUR:00000004",
180        "eventTime": "2025-12-01T09:56:34.027504"
181      }
182    ],
183    "riskStatus": "PASSED",
184    "riskReason": "",
185    "riskAction": "",
186    "deviceId": "",
187    "achSecCode": "",
188    "achHolderType": "personal",
189    "ipAddress": "255.255.255.255",
190    "isSameDayACH": false,
191    "walletType": null,
192    "splitFundingInstructions": null,
193    "pendingFeeAmount": 0,
194    "riskFlagged": false,
195    "riskFlaggedOn": "2025-12-01T09:56:32.6525967",
196    "riskActionCode": 0
197  },
198  "token": null
199}

Example Cloud success response

Response
1{
2  "code": "A0000",
3  "reason": "Approved",
4  "explanation": "Transaction approved",
5  "action": "No action required",
6  "data": {
7    "parentOrgName": "Mrinal's Pet Supplies",
8    "paypointDbaname": "Mrinal's Pet Shop North",
9    "paypointLegalname": "Mrinal's Pet Shop North",
10    "paypointEntryname": "495147f647",
11    "paymentTransId": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae",
12    "connectorName": "gp",
13    "externalProcessorInformation": "",
14    "gatewayTransId": "TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB",
15    "orderId": null,
16    "method": "card",
17    "batchNumber": "3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49",
18    "batchAmount": 420,
19    "payorId": 40144,
20    "paymentData": {
21      "maskedAccount": "4XXXXXXXXXXX5439",
22      "accountType": "visa",
23      "accountExp": "12/25",
24      "holderName": "John Cassian",
25      "storedId": null,
26      "initiator": null,
27      "storedMethodUsageType": null,
28      "sequence": null,
29      "orderDescription": "",
30      "accountId": null,
31      "signatureData": null,
32      "binData": {
33        "binMatchedLength": "6",
34        "binCardBrand": "VISA",
35        "binCardType": "CREDIT",
36        "binCardCategory": "CLASSIC",
37        "binCardIssuer": "",
38        "binCardIssuerCountry": "RUSSIAN FEDERATION",
39        "binCardIssuerCountryCodeA2": "RU",
40        "binCardIssuerCountryNumber": "643",
41        "binCardIsRegulated": "",
42        "binCardUseCategory": "",
43        "binCardIssuerCountryCodeA3": ""
44      },
45      "paymentDetails": {
46        "totalAmount": 105,
47        "serviceFee": 5,
48        "checkNumber": null,
49        "checkImage": null,
50        "checkUniqueId": "",
51        "currency": "USD",
52        "orderDescription": null,
53        "orderId": null,
54        "orderIdAlternative": null,
55        "paymentDescription": null,
56        "groupNumber": null,
57        "source": null,
58        "payabliTransId": null,
59        "unbundled": null,
60        "categories": [],
61        "splitFunding": []
62      }
63    },
64    "transStatus": 1,
65    "paypointId": 3040,
66    "totalAmount": 105,
67    "netAmount": 100,
68    "feeAmount": 5,
69    "settlementStatus": 0,
70    "operation": "Sale",
71    "responseData": {
72      "resultCode": "A0000",
73      "resultCodeText": "Approved",
74      "response": null,
75      "responsetext": "CAPTURED",
76      "authcode": "AXS425",
77      "transactionid": "TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I",
78      "avsresponse": "N",
79      "avsresponse_text": "No Match, No address or ZIP match",
80      "cvvresponse": "M",
81      "cvvresponse_text": "CVV2/CVC2 match",
82      "orderid": null,
83      "response_code": "100",
84      "response_code_text": "Operation successful",
85      "customer_vault_id": null,
86      "emv_auth_response_data": null,
87      "type": null
88    },
89    "source": "api",
90    "scheduleReference": 0,
91    "orgId": 17448,
92    "refundId": 0,
93    "returnedId": 0,
94    "chargebackId": 0,
95    "retrievalId": 0,
96    "transAdditionalData": null,
97    "invoiceData": {
98      "invoiceNumber": null,
99      "invoiceStatus": null,
100      "invoiceType": null,
101      "frequency": null,
102      "paymentTerms": null,
103      "termsConditions": null,
104      "notes": null,
105      "invoiceAmount": null,
106      "purchaseOrder": null,
107      "firstName": null,
108      "lastName": null,
109      "company": null,
110      "shippingAddress1": null,
111      "shippingAddress2": null,
112      "shippingCity": null,
113      "shippingState": null,
114      "shippingZip": null,
115      "shippingCountry": null,
116      "shippingEmail": null,
117      "shippingPhone": null,
118      "shippingFromZip": null,
119      "summaryCommodityCode": null,
120      "items": null,
121      "additionalData": null,
122      "invoiceDate": null,
123      "invoiceDueDate": null,
124      "invoiceEndDate": null,
125      "tax": null,
126      "discount": null,
127      "freightAmount": null,
128      "dutyAmount": null,
129      "attachments": null
130    },
131    "entrypageId": 0,
132    "externalPaypointID": "",
133    "isValidatedACH": false,
134    "transactionTime": "2025-12-01T09:50:03.559",
135    "customer": {
136      "identifiers": null,
137      "firstName": "David",
138      "lastName": "Beckham",
139      "companyName": "Driving School LLC",
140      "billingAddress1": "Home Address",
141      "billingAddress2": "",
142      "billingCity": "",
143      "billingState": "",
144      "billingZip": "45157",
145      "billingCountry": "US",
146      "billingPhone": "+15555555555",
147      "billingEmail": "mrinal.kundu@payabli.com",
148      "customerNumber": "C-90010",
149      "shippingAddress1": "Home Address",
150      "shippingAddress2": "",
151      "shippingCity": "",
152      "shippingState": "",
153      "shippingZip": "45157",
154      "shippingCountry": "US",
155      "customerId": 40144,
156      "customerStatus": 0,
157      "additionalData": null
158    },
159    "cfeeTransactions": [
160      {
161        "cFeeTransid": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae",
162        "feeAmount": 5,
163        "operation": "Sale",
164        "refundId": 0,
165        "responseData": {},
166        "settlementStatus": 0,
167        "transactionTime": "2025-12-01T09:50:03.559",
168        "transStatus": 1
169      }
170    ],
171    "transactionEvents": [
172      {
173        "transEvent": "Created",
174        "eventData": "0HNHD68HATSUC:00000001",
175        "eventTime": "2025-12-01T09:50:02.558651"
176      },
177      {
178        "transEvent": "Approved",
179        "eventData": "0HNHD68HATSUC:00000001",
180        "eventTime": "2025-12-01T09:50:03.609111"
181      }
182    ],
183    "riskStatus": "PASSED",
184    "riskReason": "",
185    "riskAction": "",
186    "deviceId": "",
187    "achSecCode": "",
188    "achHolderType": "personal",
189    "ipAddress": "255.255.255.255",
190    "isSameDayACH": false,
191    "walletType": null,
192    "splitFundingInstructions": null,
193    "pendingFeeAmount": 0,
194    "riskFlagged": false,
195    "riskFlaggedOn": "2025-12-01T09:50:02.5474568",
196    "riskActionCode": 0
197  },
198  "token": null
199}

To see decline and error responses, see the Make a transaction API (v2) reference.

V1 API

If you’re using the v1 API, here are examples for making a sale transaction with different payment methods:

The Card payment method is used for credit and debit card payments.

POST
/api/MoneyIn/getpaid
1from payabli import PaymentDetail, PayMethodCredit, PayorDataRequest, payabli
2
3client = payabli(
4    api_key="YOUR_API_KEY",
5)
6client.money_in.getpaid(
7    customer_data=PayorDataRequest(
8        customer_id=4440,
9    ),
10    entry_point="f743aed24a",
11    ipaddress="255.255.255.255",
12    payment_details=PaymentDetail(
13        service_fee=0.0,
14        total_amount=100.0,
15    ),
16    payment_method=PayMethodCredit(
17        cardcvv="999",
18        cardexp="02/27",
19        card_holder="John Cassian",
20        cardnumber="4111111111111111",
21        cardzip="12345",
22        initiator="payor",
23    ),
24)

The ACH payment method is used for ACH payments made with a bank account.

POST
/api/MoneyIn/getpaid
1from payabli import PaymentDetail, PayMethodAch, PayorDataRequest, payabli
2
3client = payabli(
4    api_key="YOUR_API_KEY",
5)
6client.money_in.getpaid(
7    customer_data=PayorDataRequest(
8        customer_id=4440,
9    ),
10    entry_point="f743aed24a",
11    ipaddress="255.255.255.255",
12    payment_details=PaymentDetail(
13        service_fee=0.0,
14        total_amount=100.0,
15    ),
16    payment_method=PayMethodAch(
17        ach_account="123123123",
18        ach_account_type="Checking",
19        ach_code="WEB",
20        ach_holder="John Cassian",
21        ach_holder_type="personal",
22        ach_routing="123123123",
23    ),
24)

The Stored Method payment method is used for payments made with stored methods, either tokenized credit card or tokenized ACH account.

POST
/api/MoneyIn/getpaid
1from payabli import (
2    PaymentDetail,
3    PayMethodStoredMethod,
4    PayorDataRequest,
5    payabli,
6)
7
8client = payabli(
9    api_key="YOUR_API_KEY",
10)
11client.money_in.getpaid(
12    customer_data=PayorDataRequest(
13        customer_id=4440,
14    ),
15    entry_point="f743aed24a",
16    ipaddress="255.255.255.255",
17    payment_details=PaymentDetail(
18        service_fee=0.0,
19        total_amount=100.0,
20    ),
21    payment_method=PayMethodStoredMethod(
22        initiator="payor",
23        method="card",
24        stored_method_id="1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
25        stored_method_usage_type="unscheduled",
26    ),
27)

The Cloud payment method is used for payments made with Cloud devices (payment terminals).

POST
/api/MoneyIn/getpaid
1from payabli import PaymentDetail, PayMethodCloud, PayorDataRequest, payabli
2
3client = payabli(
4    api_key="YOUR_API_KEY",
5)
6client.money_in.getpaid(
7    customer_data=PayorDataRequest(
8        customer_id=4440,
9    ),
10    entry_point="f743aed24a",
11    ipaddress="255.255.255.255",
12    payment_details=PaymentDetail(
13        service_fee=0.0,
14        total_amount=100.0,
15    ),
16    payment_method=PayMethodCloud(
17        device="6c361c7d-674c-44cc-b790-382b75d1xxx",
18        save_if_success=True,
19    ),
20)

This example shows how to include additional details in the response by setting the includeDetails parameter to true. This works with any payment method.

1    curl -X POST https://api-sandbox.payabli.com/api/MoneyIn/getpaid?includeDetails=true \
2    -H "requestToken: <apiKey>" \
3    -H "Content-Type: application/json" \
4    -d '{
5  "paymentDetails": {
6    "totalAmount": 100,
7    "serviceFee": 0
8  },
9  "paymentMethod": {
10    "initiator": "payor",
11    "method": "card",
12    "storedMethodId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
13    "storedMethodUsageType": "unscheduled"
14  },
15  "customerData": {
16    "customerId": 4440
17  },
18  "entryPoint": "f743aed24a",
19  "ipaddress": "255.255.255.255"
20}'

The response from a successful transaction includes a isSuccess boolean, a responseData object, and a responseText string. The responseData object contains additional information about the transaction, including the referenceId, which is the transaction ID.

A successful request returns a 200 response with a JSON body. The transaction ID is returned as referenceId, this is used as the transId in other endpoints.

Response
1{
2  "responseText": "Success",
3  "isSuccess": true,
4  "responseData": {
5    "authCode": "VTLMC1",
6    "referenceId": "575-c490247af7ed403d86ba583507be61b0",
7    "resultCode": 1,
8    "resultText": "Approved",
9    "avsResponseText": "Exact match, Street address and 5-digit ZIP code both match",
10    "cvvResponseText": "Not processed. Indicates that the expiration date was not provided with the request, or that the card does not have a valid CVV2 code. If the expiration date was not included with the request, resubmit the request with the expiration date.",
11    "customerId": 41892,
12    "methodReferenceId": null
13  },
14  "pageIdentifier": null
15}

If includeDetails is set to true, the response includes additional details about the transaction, which are returned in the transactionDetails object within responseData. This includes information about the customer, payment method, fees, and transaction events.

IncludeDetails example
1  {
2    "responseText": "Success",
3    "isSuccess": true,
4    "pageIdentifier": null,
5    "responseData": {
6      "transactionDetails": {
7        "parentOrgName": "Mountain View Properties",
8        "paypointDbaname": "Riverside Apartments",
9        "paypointLegalname": "Riverside Apartments LLC",
10        "paypointEntryname": "entry399",
11        "paymentTransId": "399-27260fccd280436790115892634be7c4",
12        "connectorName": "gp",
13        "externalProcessorInformation": "",
14        "gatewayTransId": "TRN_i4wWjg6iNO6HMyo1MqtRC7krpmduvR",
15        "orderId": "",
16        "method": "card",
17        "batchNumber": "399_combined_20251002_ec32a12d-baee-41e2-94dd-b0b2c6d932c4",
18        "batchAmount": 42573.28,
19        "payorId": 4119,
20        "paymentData": {
21          "maskedAccount": "5XXXXXXXXXXX4415",
22          "accountType": "mastercard",
23          "accountExp": "12/25",
24          "holderName": "Sarah Johnson",
25          "storedId": null,
26          "initiator": null,
27          "storedMethodUsageType": null,
28          "sequence": null,
29          "orderDescription": "Monthly rent payment - Unit 204",
30          "accountId": null,
31          "signatureData": null,
32          "binData": {
33            "binMatchedLength": "9",
34            "binCardBrand": "MASTERCARD",
35            "binCardType": "CREDIT",
36            "binCardCategory": "MIXED PRODUCT",
37            "binCardIssuer": "ALLIED IRISH BANKS, PLC",
38            "binCardIssuerCountry": "IRELAND",
39            "binCardIssuerCountryCodeA2": "IE",
40            "binCardIssuerCountryNumber": "372",
41            "binCardIsRegulated": "",
42            "binCardUseCategory": "",
43            "binCardIssuerCountryCodeA3": ""
44          },
45          "paymentDetails": {
46            "totalAmount": 1850.00,
47            "serviceFee": 55.50,
48            "checkNumber": null,
49            "checkImage": null,
50            "checkUniqueId": "",
51            "currency": "USD",
52            "orderDescription": null,
53            "orderId": null,
54            "orderIdAlternative": null,
55            "paymentDescription": null,
56            "groupNumber": null,
57            "source": null,
58            "payabliTransId": null,
59            "unbundled": null,
60            "categories": [],
61            "splitFunding": []
62          }
63        },
64        "transStatus": 1,
65        "paypointId": 399,
66        "totalAmount": 1850.00,
67        "netAmount": 1794.50,
68        "feeAmount": 55.50,
69        "settlementStatus": 0,
70        "operation": "Sale",
71        "responseData": {
72          "resultCode": "A0000", // New unified response code
73          "resultCodeText": "Approved", // New unified response code text
74          "response": null,
75          "responsetext": "CAPTURED",
76          "authcode": "VTLMC1",
77          "transactionid": "TRN_i4wWjg6iNO6HMyo1MqtRC7krpmduvR",
78          "avsresponse": "N",
79          "avsresponse_text": "No Match, No address or ZIP match",
80          "cvvresponse": "M",
81          "cvvresponse_text": "CVV2/CVC2 match",
82          "orderid": null,
83          "type": null,
84          "response_code": "100",
85          "response_code_text": "Operation successful.",
86          "customer_vault_id": null,
87          "emv_auth_response_data": null
88        },
89        "source": "api",
90        "scheduleReference": 0,
91        "orgId": 39,
92        "refundId": 0,
93        "returnedId": 0,
94        "chargebackId": 0,
95        "retrievalId": 0,
96        "transAdditionalData": null,
97        "invoiceData": {
98          "invoiceNumber": null,
99          "invoiceDate": null,
100          "invoiceDueDate": null,
101          "invoiceEndDate": null,
102          "invoiceStatus": null,
103          "invoiceType": null,
104          "frequency": null,
105          "paymentTerms": null,
106          "termsConditions": null,
107          "notes": null,
108          "tax": null,
109          "discount": null,
110          "invoiceAmount": null,
111          "freightAmount": null,
112          "dutyAmount": null,
113          "purchaseOrder": null,
114          "firstName": null,
115          "lastName": null,
116          "company": null,
117          "shippingAddress1": null,
118          "shippingAddress2": null,
119          "shippingCity": null,
120          "shippingState": null,
121          "shippingZip": null,
122          "shippingCountry": null,
123          "shippingEmail": null,
124          "shippingPhone": null,
125          "shippingFromZip": null,
126          "summaryCommodityCode": null,
127          "items": null,
128          "attachments": null,
129          "additionalData": null
130        },
131        "entrypageId": 0,
132        "externalPaypointID": "39990",
133        "isValidatedACH": false,
134        "transactionTime": "2025-10-02T20:51:03.261",
135        "customer": {
136          "identifiers": null,
137          "firstName": "Sarah",
138          "lastName": "Johnson",
139          "companyName": "Johnson Enterprises",
140          "billingAddress1": "425 Riverside Drive",
141          "billingAddress2": "Unit 204",
142          "billingCity": "Portland",
143          "billingState": "OR",
144          "billingZip": "97201",
145          "billingCountry": "US",
146          "billingPhone": "15035551234",
147          "billingEmail": "sarah.johnson@example.com",
148          "customerNumber": "CUST-1234",
149          "shippingAddress1": "425 Riverside Drive",
150          "shippingAddress2": "Unit 204",
151          "shippingCity": "Portland",
152          "shippingState": "OR",
153          "shippingZip": "97201",
154          "shippingCountry": "US",
155          "customerId": 4119,
156          "customerStatus": 1,
157          "additionalData": {
158            "clientId": "",
159            "customParent": "",
160            "customerId": "",
161            "customParent222": "",
162            "customerId222": "",
163            "customParent1111": "",
164            "customParent111": "",
165            "another": "",
166            "xyz": "",
167            "test12": "",
168            "customerID": ""
169          }
170        },
171        "splitFundingInstructions": null,
172        "cfeeTransactions": [
173          {
174            "cFeeTransId": "399-27260fccd280436790115892634be7c4",
175            "transStatus": 1,
176            "feeAmount": 55.50,
177            "settlementStatus": 0,
178            "operation": "Sale",
179            "responseData": {
180              "response": null,
181              "responsetext": null,
182              "authcode": null,
183              "transactionid": null,
184              "avsresponse": null,
185              "avsresponse_text": null,
186              "cvvresponse": null,
187              "cvvresponse_text": null,
188              "orderid": null,
189              "type": null,
190              "response_code": null,
191              "response_code_text": null,
192              "customer_vault_id": null,
193              "emv_auth_response_data": null,
194              "additional_response_text": null,
195              "processor_batch_id": null
196            },
197            "refundId": 0,
198            "transactionTime": "2025-10-02T20:51:03.261",
199            "gatewayTransId": null,
200            "transactionEvents": [
201              {
202                "transEvent": "Approved",
203                "eventData": null,
204                "eventTime": "2025-10-02T20:51:03.3289869"
205              }
206            ]
207          }
208        ],
209        "transactionEvents": [
210          {
211            "transEvent": "Created",
212            "eventData": "0HNG14G6KL5LG:00000001",
213            "eventTime": "2025-10-02T20:50:59.848292"
214          },
215          {
216            "transEvent": "Approved",
217            "eventData": "0HNG14G6KL5LG:00000001",
218            "eventTime": "2025-10-02T20:51:03.32107"
219          }
220        ],
221        "pendingFeeAmount": 166.50,
222        "riskFlagged": false,
223        "riskFlaggedOn": "2025-10-02T20:50:59.8361551",
224        "riskStatus": "PASSED",
225        "riskReason": "",
226        "riskAction": "",
227        "riskActionCode": 0,
228        "deviceId": "",
229        "achSecCode": "",
230        "achHolderType": "",
231        "ipAddress": "47.195.66.238",
232        "isSameDayACH": false,
233        "walletType": null
234      },
235      "authCode": "VTLMC1",
236      "referenceId": "399-27260fccd280436790115892634be7c4",
237      "resultCode": 1,
238      "resultText": "Approved",
239      "avsResponseText": "No Match, No address or ZIP match",
240      "cvvResponseText": "CVV2/CVC2 match",
241      "customerId": 4119,
242      "methodReferenceId": null
243    }
244  }

If the payment is declined, the responseText reads Declined, and resultText contains the reason for the decline.

Decline example
1  {
2    "isSuccess": false,
3    "responseData": {
4      "AuthCode": "null",
5      "avsResponseText": "No address or ZIP match only",
6      "CustomerId": 4440,
7      "cvvResponseText": "CVV2/CVC2 no match",
8      "ReferenceId": "45-erre-324",
9      "ResultCode": 1,
10      "ResultText": "200: Transaction was declined by processor.. DECLINE"
11    },
12    "responseText": "Declined"
13  }
You can use the DeclinedPayment notification to get alerts for declined transactions, including both declined credit cards and declined ACH transactions. See Notifications and Webhooks Overview for more.

Next steps

You can view transactions in the UI in your PayHub or PartnerHub account, or you can get lists of transactions via the API for paypoints or organizations

See these related resources to help you get the most out of Payabli.