Generate a primary transaction

post http://localhost:3000/payments/v1/payments

[IN DEVELOPMENT]
Use this to originate a financial transaction like a Sale, Refund, Void, Reversal, Preauthorization, Incremental or Completion.

Body Params

Payload for initiating a payment request.

Headers

Content-Type

string

required

Content type.

ClientRequestId

string

required

A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

Message-Authentication-Value

string

The Message Authentication Value (MAC) is optional and only required for Card Present transactions or those from Terminals. Format: ;;;[;][;<key version>]. Example derivation algorithms: DUKPT2009, AESDUKPT128ECB. Example MAC algorithms: RetailSHA256MAC, SHA256CMACwithAES128.

Api-Key

string

required

Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

Timestamp

int64

required

Epoch timestamp in milliseconds from the client system. Used for Message Signature generation and time limit (5 mins).

Responses

Language


xxxxxxxxxx
39
1
curl --request POST \
2
     --url http://localhost:3000/payments/v1/payments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "requestType": "Sale",
8
  "paymentMethod": {
9
    "paymentCard": {
10
      "cardFunction": "Credit",
11
      "isOfflineVerifiedPin": true
12
    },
13
    "merchantVerificationValue": "0"
14
  },
15
  "terminalRequestData": {
16
    "posEntryMode": "01"
17
  },
18
  "device": {
19
    "capabilities": {
20
      "attendance": 0,
21
      "location": 0,
22
      "cardPresent": 0,
23
      "cardCaptureCapabilities": 0,
24
      "requestStatus": 0,
25
      "activationMethod": 0,
26
      "transferingData": 0,
27
      "outputMethod": 0,
28
      "supportType": "b ",
29
      "cardholder": {

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

500Internal Server Error