Digital Platform - Card Management

/tenants/{tenantRef}/card-details
- Get card Detailspost
/tenants/{tenantRef}/card-status
- Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
- Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
- Create new card from existing cardpost

Alias Management

/tenants/{tenantRef}/merchant-alias/search
- Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
- Update Merchant Aliasput
- Delete Merchant Aliasdelete
/{nodeType}/{nodeRef}/alias
- Get all aliasget
- Create Merchant Aliaspost
/tenants/{tenantRef}/person-alias/{aliasRef}
- Update Person Aliasput
- Delete Person Aliasdelete
/tenants/{tenantRef}/person-alias
- Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
- Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
- Resolve Person Aliaspost

Reporting

/{nodeType}/{nodeRef}/invoices
- Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
- Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
- Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
- Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
- Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
- Order Sales reportsget
/{nodeType}/{merchantRef}/orders
- Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
- Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
- Get order detailsget
/{nodeType}/{hierarchyRef}/payments
- Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
- Get Paymentget

Tenant operations

/tenants/{tenantRef}/merchants
- Onboard merchantspost
/tenants/{tenantRef}/details
- Get tenant detailsget

Transaction

/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
- Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
- Fraud override for existing paymentput
/outlets/{outletId}/orders
- Create an orderpost
/outlets/{outletId}/orders/{ref}
- Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
- Accept Card for existing paymentput
/outlets/{outletId}/card/verify
- Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
- Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
- Payment Refundpost
/tenants/{tenantRef}/push-payments
- Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
- Retrieve payment details by mid, tid & auth codeget

Identity

/auth/access-token
- Generate access tokenpost

Asset Management

/{hierarchyType}/{hierarchyRef}/directories
- Get all directories for the hierarchyget
- Create Directorypost
/{hierarchyType}/{hierarchyRef}/directories/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
- Upload file to specified directorypost

Digital Platform - Card Management

/tenants/{tenantRef}/card-details
- Get card Detailspost
/tenants/{tenantRef}/card-status
- Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
- Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
- Create new card from existing cardpost

Alias Management

/tenants/{tenantRef}/merchant-alias/search
- Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
- Update Merchant Aliasput
- Delete Merchant Aliasdelete
/{nodeType}/{nodeRef}/alias
- Get all aliasget
- Create Merchant Aliaspost
/tenants/{tenantRef}/person-alias/{aliasRef}
- Update Person Aliasput
- Delete Person Aliasdelete
/tenants/{tenantRef}/person-alias
- Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
- Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
- Resolve Person Aliaspost

Reporting

/{nodeType}/{nodeRef}/invoices
- Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
- Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
- Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
- Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
- Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
- Order Sales reportsget
/{nodeType}/{merchantRef}/orders
- Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
- Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
- Get order detailsget
/{nodeType}/{hierarchyRef}/payments
- Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
- Get Paymentget

Tenant operations

/tenants/{tenantRef}/merchants
- Onboard merchantspost
/tenants/{tenantRef}/details
- Get tenant detailsget

Transaction

/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
- Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
- Fraud override for existing paymentput
/outlets/{outletId}/orders
- Create an orderpost
/outlets/{outletId}/orders/{ref}
- Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
- Accept Card for existing paymentput
/outlets/{outletId}/card/verify
- Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
- Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
- Payment Refundpost
/tenants/{tenantRef}/push-payments
- Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
- Retrieve payment details by mid, tid & auth codeget

Identity

/auth/access-token
- Generate access tokenpost

Asset Management

/{hierarchyType}/{hierarchyRef}/directories
- Get all directories for the hierarchyget
- Create Directorypost
/{hierarchyType}/{hierarchyRef}/directories/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
- Upload file to specified directorypost

Create a payment

post https://<<api_domain>>/transactions/tenants/{tenantRef}/push-payments

URL Expired

The URL for this request expired after 30 days.

Path Params

tenantRef

string

required

Unique reference for a Tenant, which is provided after tenant onboarding

Body Params

action

string

required

Payment action being performed. Accepted values DEBIT, CREDIT and FUND

channel

string

required

Source of payment initiation. Valid values are POS, App, USSD, STATIC_QR

sender

object

required

receiver

object

required

amount

object

required

transactionInformation

object

Response

Response body

object

reference

string

action

string

Payment action being performed

DEBIT DEBIT_REVERSAL CREDIT_INITIATION CREDIT FUND FUND_CREDIT FUND_DEBIT FUND_REVERSAL CREDIT_REVERSAL REFUND SCHEME_REFUND FOREX REFUND_REVERSAL

channel

string

Source of payment initiation

Ecom MoTo POS App USSD STATIC_QR

status

string

INITIATED DEBITED DEBIT_FAILED DEBIT_AUTHORIZED DEBIT_AUTHORIZATION_FAILED DEBIT_REVERSAL_AUTHORIZED DEBIT_REVERSAL_AUTHORIZATION_FAILED CREDITED CREDIT_FAILED CREDIT_REVERSAL_AUTHORIZED CREDIT_REVERSAL_AUTHORIZATION_FAILED CREDIT_REVERSED CREDIT_REVERSAL_FAILED CREDIT_AUTHORIZED CREDIT_AUTHORIZATION_FAILED REFUND_IN_PROGRESS REFUNDED REFUND_FAILED PARTIALLY_REFUNDED PARTIAL_REFUND_FAILED REFUND_REVERSAL_SUCCESS REFUND_REVERSAL_FAILED

sender

object

type

string

This should always be set as PERSON

PERSON MERCHANT

person

object

required

receiver

object

type

string

required

Type of receiver

PERSON MERCHANT

merchant

object

required

person

object

required

amount

object

currencyCode

string

required

Currency should be ISO three-letter alphabet code

value

int64

required

Amount should be in Micro currency format. If the transaction amount is 100.25 AED, then 10025 should be passed.

transactionInformation

array of objects

Transaction history

transactionInformation

object

transactionNumber

string

authCode

string

Auth code of the successful transaction

rrn

string

Retrieval reference number of the transaction

captureDate

string

systemTraceAuditNumber

string

System trace audit number of the successful transaction

resultCode

string

success

boolean

verificationRemark

string

verificationCode

string

conversionRate

string

chargesApplied

string

system

string

TRANSACTION_MANAGER MASTERCARD_SWITCH MASTERCARD VISA EXTERNAL_FINANCIAL_SYSTEM

base24Time

string

base24Date

string

amount

object

action

string

DEBIT DEBIT_REVERSAL CREDIT_INITIATION CREDIT FUND FUND_CREDIT FUND_DEBIT FUND_REVERSAL CREDIT_REVERSAL REFUND SCHEME_REFUND FOREX REFUND_REVERSAL

createdDateTime

int64

p2MTransaction

boolean

Updated over 4 years ago

/tenants/{tenantRef}/push-payments

/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}

Language

Credentials

Header


xxxxxxxxxx
38
1
curl --request POST \
2
     --url https:///%3C%3Capi_domain%3E%3E/transactions/tenants/tenantRef/push-payments \
3
     --header 'accept: application/vnd.ni-payment.v2+json' \
4
     --header 'content-type: application/vnd.ni-payment.v2+json' \
5
     --data '
6
{
7
  "action": "DEBIT",
8
  "channel": "Ecom",
9
  "sender": {
10
    "person": {
11
      "card": {
12
        "type": "DEBIT",
13
        "scheme": "VISA"
14
      },
15
      "alias": {
16
        "type": "EMAIL",
17
        "source": "MASTERCARD"
18
      }
19
    }
20
  },
21
  "receiver": {
22
    "type": "PERSON",
23
    "merchant": {
24
      "scheme": "VISA"
25
    },
26
    "person": {
27
      "card": {
28
        "type": "DEBIT",
29
        "scheme": "VISA"

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

application/vnd.ni-payment.v2+json

Updated over 4 years ago

/tenants/{tenantRef}/push-payments

/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}

Digital Platform - Card Management
/tenants/{tenantRef}/card-details
Get card Detailspost
/tenants/{tenantRef}/card-status
Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
Create new card from existing cardpost

Alias Management
/tenants/{tenantRef}/merchant-alias/search
Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
Delete Merchant Aliasdelete
Update Merchant Aliasput
/{nodeType}/{nodeRef}/alias
Create Merchant Aliaspost
Get all aliasget
/tenants/{tenantRef}/person-alias/{aliasRef}
Delete Person Aliasdelete
Update Person Aliasput
/tenants/{tenantRef}/person-alias
Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
Resolve Person Aliaspost

Reporting
/{nodeType}/{nodeRef}/invoices
Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
Order Sales reportsget
/{nodeType}/{merchantRef}/orders
Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
Get order detailsget
/{nodeType}/{hierarchyRef}/payments
Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
Get Paymentget

Tenant operations
/tenants/{tenantRef}/merchants
Onboard merchantspost
/tenants/{tenantRef}/details
Get tenant detailsget

Transaction
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
Fraud override for existing paymentput
/outlets/{outletId}/orders
Create an orderpost
/outlets/{outletId}/orders/{ref}
Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
Accept Card for existing paymentput
/outlets/{outletId}/card/verify
Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
Payment Refundpost
/tenants/{tenantRef}/push-payments
Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
Retrieve payment details by mid, tid & auth codeget

Identity
/auth/access-token
Generate access tokenpost

Asset Management
/{hierarchyType}/{hierarchyRef}/directories
Create Directorypost
Get all directories for the hierarchyget
/{hierarchyType}/{hierarchyRef}/directories/{reference}
Delete the directory by referencedelete
Update the directory by referenceput
Get directory for the referenceget
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
Delete file by file referencedelete
Update file by file referenceput
Get file by file referenceget
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
Upload file to specified directorypost

Digital Platform - Card Management
/tenants/{tenantRef}/card-details
Get card Detailspost
/tenants/{tenantRef}/card-status
Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
Create new card from existing cardpost

Alias Management
/tenants/{tenantRef}/merchant-alias/search
Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
Delete Merchant Aliasdelete
Update Merchant Aliasput
/{nodeType}/{nodeRef}/alias
Create Merchant Aliaspost
Get all aliasget
/tenants/{tenantRef}/person-alias/{aliasRef}
Delete Person Aliasdelete
Update Person Aliasput
/tenants/{tenantRef}/person-alias
Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
Resolve Person Aliaspost

Reporting
/{nodeType}/{nodeRef}/invoices
Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
Order Sales reportsget
/{nodeType}/{merchantRef}/orders
Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
Get order detailsget
/{nodeType}/{hierarchyRef}/payments
Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
Get Paymentget

Tenant operations
/tenants/{tenantRef}/merchants
Onboard merchantspost
/tenants/{tenantRef}/details
Get tenant detailsget

Transaction
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
Fraud override for existing paymentput
/outlets/{outletId}/orders
Create an orderpost
/outlets/{outletId}/orders/{ref}
Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
Accept Card for existing paymentput
/outlets/{outletId}/card/verify
Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
Payment Refundpost
/tenants/{tenantRef}/push-payments
Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
Retrieve payment details by mid, tid & auth codeget

Identity
/auth/access-token
Generate access tokenpost

Asset Management
/{hierarchyType}/{hierarchyRef}/directories
Create Directorypost
Get all directories for the hierarchyget
/{hierarchyType}/{hierarchyRef}/directories/{reference}
Delete the directory by referencedelete
Update the directory by referenceput
Get directory for the referenceget
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
Delete file by file referencedelete
Update file by file referenceput
Get file by file referenceget
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
Upload file to specified directorypost

200successful operation