• Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
  • Home
  • Our APIs
  • Guides
  • Our Products
    • Nothing Found
    v1.0
    Introduction
    Authentication
    Currency
    Terminals
    Intent
      get
      Get intent by ID
      post
      Create payment intent
      post
      Create Pre-Auth create intent
      post
      Create Pre-Auth capture intent
      post
      Create a Pre-Auth cancel intent
      post
      Create refund intent
      post
      Create reversal intent
      post
      Create NFT intents
      post
      Cancel an intent being processed
      post
      Request a terminal to process an intent

Get intent by ID

A functionality to obtain the status and result (if available) of an intent.

Used as an alternative method of obtaining intent results (polling results instead of webhooks from post-backs)

Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

intentId
required
string

Intent Identifier.

Responses
200

Returned intent body.

401

Invalid API key/MID.

403

Forbidden from performing this action.

404
500
get/merchant/{mid}/intent/{intentId}
Response samples
  • 200
  • 401
  • 403
  • 404
  • 500
application/json
{
  • "intentId": "9b966aba-7d18-4a93-b6a8-43845b096776",
  • "type": "REPRINT_RECEIPT",
  • "status": "PENDING",
  • "intentDetails": { },
  • "transactionId": "string",
  • "transactionDetails": {
    • "transactionId": "transaction-123",
    • "intentId": "intent-123",
    • "status": "completed",
    • "paymentAmount": 100,
    • "statusMessage": "string",
    • "amount": {
      • "subTotal": 1000,
      • "surcharge": 10,
      • "tip": 100,
      • "tax": 100
      },
    • "paymentMethod": {
      • "type": "CARD",
      • "card": {
        • "cardCurrency": "string",
        • "last4Digit": "string",
        • "scheme": "string",
        • "cardType": "string",
        • "tokenId": "string",
        • "paymentToken": "string"
        },
      • "wallet": {
        • "walletId": "string",
        • "type": "string",
        • "paymentToken": "string",
        • "tokenId": "string",
        • "owner": "string",
        • "referenceId": "string"
        }
      },
    • "host": {
      • "authCode": "string",
      • "authResponseCode": "string",
      • "authResponseText": "string",
      • "authDateTime": "string"
      },
    • "externalRef": "string",
    • "merchantReference": "string",
    • "rawReceipt": "string",
    • "terminalId": "string",
    • "transactionData": {
      • "transactionCurrency": "string",
      • "transactionType": "string",
      • "transactionDateTime": "string",
      • "externalReferenceNumber": "string"
      },
    • "metadata": { },
    • "cardInputMethod": "string",
    • "externalData": "string"
    }
}
Legal
  • Privacy Policy
Support
  • Contact us
© Copyright Till Payments 2023. All right reserved.