Make a Payment

Description

The makeAPayment endpoint is used to submit a payment request to a payment gateway. An "authorization" (auth) will be submitted for credit cards or PINless debit cards used as a credit card. The Transaction will be processed as "sale" always for an eCheck, PINless Debit Cards, Bancario Boleto and Pix Payment Methods.”

Requests can be done with a "new payment method" or an "existing payment method." New payment methods are those that the user enters manually, whereas existing payment methods are those that have been "tokenized" and can be used without entering the full card information.

Request

Endpoint

/ui/v1/makeAPayment

Method

POST

Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Attributes

A • is a child element, • • is a grandchild element, • • •  is a great-grandchild element.

ELEMENT DESCRIPTION FORMAT
money Required

Array index
• amount Required

Payment amount		 10.00

The maximum Amount limit is 999,999.99
• currency Required

array index
•• currencyCode Required

3-character currency code		 Currency Codes
paymentType Required
• name Required

Name of Payment Type being used		 Payment Types
• paymentAction Required

Name of the Payment Action being used		 • PRE_AUTHORIZATION
• SALE
• FORCE_CAPTURE
• ZERO_DOLLAR_AUTH
consolidatedPayInfo Required

Array index
• payments Required

Array index
•• type Required

Type of payment method being used		 • creditcard
• echeck
• pinlessdebitcard
• paypal
•• paymentMethodType Required

Payment method type name		 Payment Method Types
•• cardNetworkName Conditional
Applies to credit card and debit card payments only.

Card network name		 Card Networks
•• nameOnCard Conditional
Required for Realex

Cardholder's name		 John Smith
•• firstName Conditional
Required for CyberSource, PayPal

Cardholder's first name		 John
•• lastName Conditional
Required for CyberSource, PayPal

Card holder's last name		 Smith
•• cardNumber Conditional
Required for credit cards or PINless debit cards

Credit/debit card number		 4111111111111111
•• expiryMonth Conditional
Required for credit cards or PINless debit cards

2-digit expiration month		 08
•• expiryYear Conditional
Required for credit cards or PINless debit cards

2-digit expiration year		 20
•• CVN Conditional
Required if Card Security Code validation is enabled

CVV/CVN		 4 digits for American Express cards, 3 digits for others
•• processDebitOrCredit Conditional
Required for PINless debit

Whether a transaction will be processed as credit or debit		 • debit
• credit
•• subscriptionId Conditional
Required if using a saved/tokenized payment method

Subscription ID		 1122334455667788
•• routingNumber Conditional
Required for eCheck

Bank account's routing number		 0111111111
•• accountNumber Conditional
Required for eCheck

Account Number		 1234567890
•• accountHolderName Conditional
Required for eCheck

Account Holder Name		 John Smith
•• bankName Optional
Optional for eCheck

Bank name		 Test Bank
•• accountType Conditional
Optional for eCheck

Type of bank account		 Account Types
•• dateOfBirth Conditional
Optional for eCheck

Date of Birth of the Account Holder		 2000-04-13
•• driversLicenseNumber Conditional
Optional for eCheck

Driver's License Number		 123123123
•• driversLicenseState Conditional
Optional for eCheck

Driver's License State		 GA
•• issueDate Conditional
Optional for Money Order

Issue date for Money Order		 2023-04-06
•• checkNumber Conditional
Optional for Money Order		 1234567
•• moneyOrderNumber Conditional
Optional for Money Order		 123456789
•• billingAddress Conditional
Required if billing address validation is enabled

Array index
••• country Conditional
Required if billing address validation is enabled

Billing address country which is a 3 character alpha code		 Country Code
••• state Conditional
Required if billing address validation is enabled

Billing address state which is a 2 character alpha code		 States/Provinces
••• city Conditional
Required if billing address validation is enabled

Billing address city		 Atlanta
••• addressLine1 Conditional
Required if billing address validation is enabled

Street address		 123 Maple Street
••• addressLine2 Optional

Apartment/suite number		 Apt. 2A
••• streetName Optional

Address that is related to the card used.

when the selected country is Brazil		 e.g., Near XXXX
••• streetNumber Optional

Address that is related to the card used.

when the selected country is Brazil		 e.g., Near 1234
••• zipCode Conditional
Required if billing address validation is enabled

Billing address ZIP/postal code		 12345
•• money Required

Amount		 10.00 or 1000
Include decimal (e.g., 10.00) for CyberSource, omit (e.g., 1000) for Realex
•• currency Required

Array index
••• currencyCode Required

3-character currency code		 Currency Codes
•• paymentGatewayType Required

Array index
••• name Required

Name of payment gateway processing the payment		 Payment Gateways
•• payWith Required

New or saved payment method		 • NEW_PAYMENT_METHOD
• EXISTING_PAYMENT_METHOD
• checkInDate Optional

Date on which the customer is checking in		 21-04-2024

Date format is dependent on the Merchant Configuration
• checkOutDate Optional

Date on which the customer is checking out		 24-04-2024

Date format is dependent on the Merchant Configuration
• membershipNumber Optional

Membership number of the user for whom the payment is being made		 EX: 123456
• bookingNumber Optional

Booking or the Transaction Number of the payment		 123456
• productCode Optional

Product or service Code to which the payment has been made		 Ex: ABCD123

Credit Card Payment

Request (New Payment Method)

{
    "money": {
        "amount": "17150",
        "currency": {
            "currencyCode": "DOP",
            "isoNumericCode": "214"
        }
    },
    "paymentType": {
        "name": "SINGLE_PAYMENT"
    },
    "consolidatedPayInfo": {
        "payments": [{
            "type": "creditcard",
            "paymentMethodType": "CREDIT_CARD",
            "cardNetworkName": "VISA",
            "nameOnCard": "John Smith",
            "firstName": "",
            "lastName": "",
            "companyName": "",
            "cardNumber": "4012000033330026",
            "expiryMonth": "05",
            "expiryYear": "31",
            "cvn": "123",
            "cardSwipe": false,
            "posKeyed": false,
            "emvContact": false,
            "geolocation": "{\"city\":\"Alpharetta\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1675442973127,\"location\":{\"latitude\":34.0710281,\"longitude\":-84.1751545,\"address\":\"6910 McGinnis Ferry Rd, Alpharetta, GA 30005, USA\",\"placeId\":\"ChIJMwYv7S-Z9YgRrJkybozeVgg\",\"altitude\":null,\"accuracy_radius\":6987.659440673114,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36\",\"remoteHost\":\"\"}",
            "processDebitOrCredit": "",
            "refundMethod": {
                "name": "ORIGINAL_PAYMENT_METHOD"
            },
            "refundStatus": {
                "name": "NONE"
            },
            "voidStatus": {
                "name": "NONE"
            },
            "orderId": "",
            "subscriptionId": "",
            "reEnterAccountNumber": "",
            "accountHolderName": "",
            "dateOfBirth": "",
            "driversLicenseNumber": "",
            "driversLicenseState": null,
            "billingAddress": {
                "country": "DOM",
                "state": "AL",
                "city": "Higuey",
                "addressLine1": "APT POSTAL 106",
                "addressLine2": "",
                "addressLine3": "",
                "streetNumber": "",
                "streetName": "",
                "zipCode": "23000"
            },
            "money": {
                "amount": "17150",
                "currency": {
                    "currencyCode": "DOP",
                    "isoNumericCode": "214"
                }
            },
            "paymentGateway": {
                "name": "FISERV_DATAWIRE_ISO_8583"
            },
            "payWith": "CARD_NOT_PRESENT",
            "posTerminalId": "",
            "arqcData": "",
            "serialNumber": "",
            "trackData1": "",
            "trackData2": "",
            "encryptedTrack1": "",
            "encryptedTrack2": "",
            "encryptedTrack": false,
            "posEntryMode": {
                "name": "MANUAL_ENTRY_WIRED"
            },
            "ksn": "",
            "posDeviceType": {
                "name": "NONE"
            },
            "authCode": "",
            "convenienceFees": 0,
            "channel": {
                "id": "86"
            },
            "issueDate": "",
            "checkNumber": "",
            "moneyOrderNumber": "",
            "storeCreditNumber": "",
            "storeCreditPIN": "",
            "fallbackMSR": false,
            "identityType": {
                "name": null
            },
            "identityNumber": "",
            "reEnterIdentityNumber": "",
            "processAsQRCode": false
        }]
    },
    "paymentCycle": null,
    "transactionType": {
        "name": "PRE_AUTHORIZATION"
    },
    "ssoEnabledInd": "false",
    "threeDSecurePaReq": "",
    "threeDSecureURL": "",
    "threeDSecureVISAPit": "",
    "realexRequestId": "",
    "threeDSecureEncodedMD": "",
    "password": "password",
    "paymentMethodName": "",
    "invoiceNumber": "1234567",
    "customerNumber": "",
    "voidReason": "",
    "refundReason": "",
    "transactionCategory": {
        "name": "CARD_NOT_PRESENT"
    },
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "memo": "",
    "addProfileAsPartOfAuthRequest": false,
    "merchantId": "11",
    "userRole": "MERCHANT_ADMIN",
    "uiType": "",
    "emailAddress": "Smithh@gmail.com",
    "reEnterEmailAddress": "smithh@gmail.com",
    "mobileNumber": "",
    "reEnterMobileNumber": "",
    "textMessageType": {
        "name": "SMS"
    },
    "mobileCountryCallingCodeId": 66,
    "mobilePhoneCarrierType": {
        "name": "UNKNOWN",
        "emailDomain": "",
        "value": "Select"
    },
    "id": "",
    "createdUserId": "",
    "disablePaymentType": false,
    "disableAmount": true,
    "digitalSignature": "",
    "agreeToPayInd": false,
    "agreeToAcceptRefundInd": false,
    "goodsAndServicesPurchaseType": {
        "name": "SERVICE"
    },
    "checkInDate": "",
    "checkOutDate": "",
    "recurrenceEndDate": "",
    "bookingNumber": "",
    "groupName": "",
    "customerName": "John Smith",
    "membershipNumber": "",
    "merchantLocation": null,
    "customerId": "",
    "numberOfCards": "1",
    "confirmationInd": false,
    "productCode": "PUNC001",
    "geolocation": "{\"city\":\"Alpharetta\",\"country\":{\"code\":\"US\",\"name\":\"United States\"},\"timestamp\":1675442973127,\"location\":{\"latitude\":34.0710281,\"longitude\":-84.1751545,\"address\":\"6910 McGinnis Ferry Rd, Alpharetta, GA 30005, USA\",\"placeId\":\"ChIJMwYv7S-Z9YgRrJkybozeVgg\",\"altitude\":null,\"accuracy_radius\":6987.659440673114,\"altitudeAccuracy\":null,\"heading\":null,\"speed\":null,\"time_zone\":\"America/New_York\"},\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36\",\"remoteHost\":\"\"}",
    "qualifiedHealthcareAmount": null,
    "amountType": {
        "name": "UNKNOWN"
    },
    "numberOfInstallments": null,
    "sameAsUserAddress": [false, false]
}

Updated As Of Version 5.5.1.1