• Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
  • Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
    v1.0
    Introduction
    Authentication
    Payment
      post
      Initiate transaction from online channel
      get
      Get specific payment detail
      post
      update Pre-auth payment or any pending payment
      post
      cancel the pre-auth
      post
      complete pre-auth payment (full or partial amount)
      post
      refund a payment
      post
      reverse a payment
      post
      3ds authentication flow
      post
      notify 3ds challenge completion & authorise the payment

complete pre-auth payment (full or partial amount)

Securityapi_key
Request
path Parameters
paymentId
required
string
Request Body schema: application/json
required
object (TMerchantData)

merchant related data

amount
number
Default: "full amount"

by default, the service will populate the remaining amount - full amount from original transaction minus the previous completion amount. Otherwise, it is partial completion (less or equal to the remaining amount)

customerId
string

only applicable for registered customer. need to be matched with the original transaction

channel
string
Default: "ECOMMERCE"
Enum: "ECOMMERCE" "POS" "MAIL_ORDER" "TELEPHONE_ORDER" "OTHER"
object

this metadata is used to address any specific merchants / partners integration requirements.

Responses
200

Successful response.

400

Invalid Request

401

Invalid API key.

403

Forbidden from performing this action.

500
post/online/v1/payment/{paymentId}/complete
Request samples
  • Payload
application/json
{
  • "merchantData": {
    • "merchantTransactionId": "YOUR_MERCHANT_UNIQUE_TXN_ID",
    • "transactionUUID": "YOUR_MERCHANT_UNIQUE_TXN_UUID"
    },
  • "customerId": "YOUR_CUSTOMER_ID",
  • "amount": 718,
  • "channel": "ECOMMERCE"
}
Response samples
  • 200
  • 400
  • 401
  • 403
  • 500
application/json
{
  • "transactionReceipt": "string",
  • "payment": {
    • "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
    • "amount": 0,
    • "currency": "string",
    • "description": "string",
    • "autoComplete": true,
    • "standingInstruction": {
      • "type": "RECURRING",
      • "recurringType": "STANDING_ORDER",
      • "initialTransactionId": "string",
      • "mode": "INITIAL",
      • "industryPractice": "RESUBMISSION"
      },
    • "register": true,
    • "customer": {
      • "customerId": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "dob": "string",
      • "gender": "M",
      • "emailId": "string",
      • "billingAddress": {
        • "addressLine1": "string",
        • "addressLine2": "string",
        • "city": "string",
        • "state": "string",
        • "postcode": "string",
        • "country": "string"
        },
      • "shippingFirstName": "string",
      • "shippingLastName": "string",
      • "shippingCompanyName": "string",
      • "shippingAddress": {
        • "addressLine1": "string",
        • "addressLine2": "string",
        • "city": "string",
        • "state": "string",
        • "postcode": "string",
        • "country": "string"
        },
      • "status": "ACTIVE",
      • "externalReferenceId": "string",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "lastModifiedDate": "2019-08-24T14:15:22Z"
      },
    • "paymentMethod": {
      • "paymentMethodId": "string",
      • "type": "CARD",
      • "card": {
        • "cardId": "string",
        • "cardHolder": "string",
        • "paymentToken": "string",
        • "tokenId": "string",
        • "scheme": "string",
        • "threeDSecureUsage": true,
        • "bin": "string",
        • "last4Digit": "string",
        • "expiryMonth": "string",
        • "expiryYear": "string"
        },
      • "wallet": {
        • "walletId": "string",
        • "type": "string",
        • "paymentToken": "string",
        • "tokenId": "string",
        • "owner": "string",
        • "referenceId": "string"
        },
      • "preferred": true,
      • "status": "ACTIVE",
      • "threeDSResult": {
        • "eci": "string",
        • "authenticationValue": "string",
        • "messageVersion": "string",
        • "dsTransId": "string",
        • "transStatus": "string",
        • "xid": "string"
        },
      • "nextAction": {
        • "redirectType": "3DS_REDIRECT",
        • "threeDSRedirect": {
          • "threeDSMethodURL": "string",
          • "threeDSMethodData": "string",
          • "threeDSServerTransID": "string"
          }
        }
      },
    • "subscription": {
      • "subscriptionId": "string",
      • "status": "ACTIVE",
      • "amount": 0,
      • "currency": "string",
      • "startDate": "string",
      • "endDate": "string",
      • "frequency": "DAILY",
      • "paymentMethod": {
        • "paymentMethodId": "string",
        • "type": "CARD",
        • "card": {
          • "cardId": "string",
          • "cardHolder": "string",
          • "paymentToken": "string",
          • "tokenId": "string",
          • "scheme": "string",
          • "threeDSecureUsage": true,
          • "bin": "string",
          • "last4Digit": "string",
          • "expiryMonth": "string",
          • "expiryYear": "string"
          },
        • "wallet": {
          • "walletId": "string",
          • "type": "string",
          • "paymentToken": "string",
          • "tokenId": "string",
          • "owner": "string",
          • "referenceId": "string"
          },
        • "preferred": true,
        • "status": "ACTIVE",
        • "threeDSResult": {
          • "eci": "string",
          • "authenticationValue": "string",
          • "messageVersion": "string",
          • "dsTransId": "string",
          • "transStatus": "string",
          • "xid": "string"
          },
        • "nextAction": {
          • "redirectType": "3DS_REDIRECT",
          • "threeDSRedirect": {
            • "threeDSMethodURL": "string",
            • "threeDSMethodData": "string",
            • "threeDSServerTransID": "string"
            }
          }
        },
      • "mandate": {
        • "mandateId": "string",
        • "customerId": "string",
        • "acceptedDate": "string",
        • "status": "PENDING",
        • "createdDate": "string"
        },
      • "createdDate": "string",
      • "lastUpdatedDate": "string"
      },
    • "threeDSResult": {
      • "eci": "string",
      • "authenticationValue": "string",
      • "messageVersion": "string",
      • "dsTransId": "string",
      • "transStatus": "string",
      • "xid": "string"
      },
    • "nextAction": {
      • "redirectType": "3DS_REDIRECT",
      • "threeDSRedirect": {
        • "threeDSMethodURL": "string",
        • "threeDSMethodData": "string",
        • "threeDSServerTransID": "string"
        }
      },
    • "metadata": {
      • "merchantAdviceCode": 2,
      • "rrn": 12345678,
      • "stan": 123456,
      • "auth-code": 123456
      }
    },
  • "result": {
    • "resultType": "COMPLETED",
    • "resultDescription": "string",
    • "errorCode": "string",
    • "errorDescription": "string",
    • "externalErrorCode": "string",
    • "externalErrorDescription": "string"
    }
}
Legal
  • Privacy Policy
Support
  • Contact us
© Copyright Till Payments 2023. All right reserved.