Make transaction

Deprecated

POST

/MoneyIn/getpaid

POST

/api/MoneyIn/getpaid

$ curl -X POST https://api-sandbox.payabli.com/api/MoneyIn/getpaid \
>      -H "requestToken: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "paymentDetails": {
>     "totalAmount": 100,
>     "serviceFee": 0
>   },
>   "paymentMethod": {
>     "cardcvv": "999",
>     "cardexp": "02/27",
>     "cardHolder": "John Cassian",
>     "cardnumber": "4111111111111111",
>     "cardzip": "12345",
>     "initiator": "payor",
>     "method": "card"
>   },
>   "customerData": {
>     "customerId": 4440
>   },
>   "entryPoint": "8cfec329267",
>   "ipaddress": "255.255.255.255"
> }'

1 {
2   "responseText": "Success",
3   "isSuccess": true,
4   "responseData": {
5     "authCode": "VTLMC1",
6     "referenceId": "129-219",
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": 4440,
12     "methodReferenceId": null
13   },
14   "pageIdentifier": null
15 }

This endpoint is deprecated. New integrations should use the Make a transaction endpoint and manage the resulting transaction with the corresponding void or refund endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren’t interchangeable with the current ones.

Make a single transaction. This method authorizes and captures a payment in one step.

<Warning> This endpoint is deprecated. New integrations should use the [Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) and manage the resulting transaction with the corresponding void or refund endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones. </Warning> Make a single transaction. This method authorizes and captures a payment in one step.

Authentication

requestTokenstring

API Key authentication via header

Query parameters

achValidationbooleanOptional

When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.

forceCustomerCreationbooleanOptional

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.

includeDetailsbooleanOptional

When true, transactionDetails object is returned in the response. See a full example of the transactionDetails object in the Transaction integration guide.

Request

This endpoint expects an object.

paymentDetailsobjectRequired

Object describing details of the payment. Required.

paymentMethodobjectRequired

Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.

accountIdstringOptional

Custom identifier for payment connector.

customerDataobjectOptional

Object describing the Customer/Payor. Which fields are required depends on the paypoint’s custom identifier settings.

entryPointstringOptional<=50 characters

The entrypoint identifier.

invoiceDataobjectOptional

Object describing an Invoice linked to the transaction.

ipaddressstringOptional

The IP address associated with the transaction.

orderDescriptionstringOptional<=250 characters

Text description of the transaction.

orderIdstringOptional<=250 characters

Custom identifier for the transaction.

sourcestringOptional<=100 characters

Custom identifier to indicate the transaction or request source.

subdomainstringOptional<=50 characters

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

subscriptionIdlongOptional

Payabli identifier of the subscription associated with the transaction.

Response

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDataobject

Response data for GetPaid transactions

pageIdentifierstring

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error

Authentication

Headers

Query parameters

Request

Response

Errors