Fetch checkout transaction

curl --request GET \
  --url https://api.nomba.com/v1/checkout/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'

{
  "code": "00",
  "description": "Success",
  "data": {
    "success": "true",
    "message": "success",
    "order": {
      "orderId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58",
      "customerId": "762878332454",
      "accountId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "callbackUrl": "https://ip:port/merchant.com/callback",
      "customerEmail": "[email protected]",
      "amount": "10000.00",
      "currency": "NGN"
    },
    "transactionDetails": {
      "transactionDate": "2023-12-06T15:46:43.000Z",
      "paymentReference": "5844858382134",
      "paymentVendorReference": "5844858382675493",
      "tokenizedCardPayment": "true",
      "statusCode": "Payment approved"
    },
    "transferDetails": {
      "sessionId": "67584432178569543",
      "beneficiaryAccountName": "Tope Fade",
      "beneficiaryAccountNumber": "5844858382",
      "originatorAccountName": "Femi Fash",
      "originatorAccountNumber": "3409082834",
      "narration": "Checkout payment",
      "destinationInstitutionCode": "true",
      "paymentReference": "44384586756"
    },
    "cardDetails": {
      "cardPan": "515123 **** **** 6667",
      "cardType": "Verve",
      "cardCurrency": "NGN",
      "cardBank": "057"
    }
  }
}

GET

checkout

transaction

Fetch checkout transaction

curl --request GET \
  --url https://api.nomba.com/v1/checkout/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'

{
  "code": "00",
  "description": "Success",
  "data": {
    "success": "true",
    "message": "success",
    "order": {
      "orderId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58",
      "customerId": "762878332454",
      "accountId": "56e03654-0c32-4d3e-bbd6-a9df22994a12",
      "callbackUrl": "https://ip:port/merchant.com/callback",
      "customerEmail": "[email protected]",
      "amount": "10000.00",
      "currency": "NGN"
    },
    "transactionDetails": {
      "transactionDate": "2023-12-06T15:46:43.000Z",
      "paymentReference": "5844858382134",
      "paymentVendorReference": "5844858382675493",
      "tokenizedCardPayment": "true",
      "statusCode": "Payment approved"
    },
    "transferDetails": {
      "sessionId": "67584432178569543",
      "beneficiaryAccountName": "Tope Fade",
      "beneficiaryAccountNumber": "5844858382",
      "originatorAccountName": "Femi Fash",
      "originatorAccountNumber": "3409082834",
      "narration": "Checkout payment",
      "destinationInstitutionCode": "true",
      "paymentReference": "44384586756"
    },
    "cardDetails": {
      "cardPan": "515123 **** **** 6667",
      "cardType": "Verve",
      "cardCurrency": "NGN",
      "cardBank": "057"
    }
  }
}

Authorizations

Authorization

string

header

required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId

string<uuid>

required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Query Parameters

idType

enum<string>

Checkout id type to use for this query. Valid values are the 'ORDER_REFERENCE', to use Order reference passed in when generating the checkout link, and 'ORDER_ID' to use the uuid value returned in the checkout link path.

Available options:

ORDER_ID,

ORDER_REFERENCE

string

Checkout transaction id based on the value selected in the idType parameter

Response

OK - your request was successful.

code

string

Response Code

Example:

"00"

description

string

response description

Example:

"Success"

data

object

Show child attributes

data.success

boolean

True if the transaction is already completed and successful, false otherwise

Example:

"true"

data.message

string

Response message describing the transaction status

Example:

"success"

data.order

object

Show child attributes

data.order.orderId

string

Id generated by Nomba for the checkout order

Example:

"56e03654-0c32-4d3e-bbd6-a9df22994a12"

data.order.orderReference

string

Reference of the online checkout order to be created

Example:

"90e81e8a-bc14-4ebf-89c0-57da752cca58"

data.order.customerId

string

Customer id

Example:

"762878332454"

data.order.accountId

string

The account Id whose wallet will be credited when the order is paid

Example:

"56e03654-0c32-4d3e-bbd6-a9df22994a12"

data.order.callbackUrl

string

Merchant callback url for redirect after payment

Example:

"https://ip:port/merchant.com/callback"

data.order.customerEmail

string

Customer email

Example:

"[email protected]"

data.order.amount

number<double>

Amount to pay

Example:

"10000.00"

data.order.currency

enum<string>

Currency of the money

Available options:

NGN

Example:

"NGN"

data.transactionDetails

object

Show child attributes

data.transactionDetails.transactionDate

string<date-time>

Date the transaction was created

Example:

"2023-12-06T15:46:43.000Z"

data.transactionDetails.paymentReference

string

The payment reference for the transaction

Example:

"5844858382134"

data.transactionDetails.paymentVendorReference

string

The payment reference returned by the payment gateway

Example:

"5844858382675493"

data.transactionDetails.tokenizedCardPayment

boolean

True if the payment was made by a tokenized card

Example:

"true"

data.transactionDetails.statusCode

string

transaction status code returned by the payment gateway

Example:

"Payment approved"

data.transferDetails

object

Show child attributes

data.transferDetails.sessionId

string

Transfer sessionId

Example:

"67584432178569543"

data.transferDetails.beneficiaryAccountName

string

The account name associated with the Merchants Nombank account

Example:

"Tope Fade"

data.transferDetails.beneficiaryAccountNumber

string

The Flash account number, where the payment was made to

Example:

"5844858382"

data.transferDetails.originatorAccountName

string

The name of the person making the transfer

Example:

"Femi Fash"

data.transferDetails.originatorAccountNumber

string

Nuban account number of the person making the transfer

Example:

"3409082834"

data.transferDetails.narration

string

The naration added by the customer when making the transfer

Example:

"Checkout payment"

data.transferDetails.destinationInstitutionCode

string

Destination bank code

Example:

"true"

data.transferDetails.paymentReference

string

Transfer payment reference passed in from NIBSS for the transfer

Example:

"44384586756"

data.cardDetails

object

Show child attributes

data.cardDetails.cardPan

string

The masked card pan

Example:

"515123 **** **** 6667"

data.cardDetails.cardType

string

The Card type

Example:

"Verve"

data.cardDetails.cardCurrency

string

The card currency

Example:

"NGN"

data.cardDetails.cardBank

string

Card Bank code

Example:

"057"

Delete tokenized card data

Get Order details based on the generated Order reference

⌘I

API Documentation

Authenticate

Accounts

Virtual Accounts

Online Checkout

Charge

Direct Debits

Transfers

Terminals

Transactions

Airtime & Data Vending

Cable & Bill Payments

Betting

Fetch checkout transaction

Authorizations

Headers

Query Parameters

Response