Overview

The Card Payment gateway is organized around REST. The API utilizes resource-oriented URLs, and uses HTTP response codes to indicate API errors. JSON is consumed and returned by all API responses, including errors. All requests should be sent to cardgw-test.riverbank.co.ke.

844-376-6324Version information

Version: 1.0.0

URI scheme

Host: cardgw-test.riverbank.co.ke Schemes: HTTPS

Consumes

  • application/json

226-618-7588Produces

  • application/json

Paths

Request for card payment

POST /pay/with_token

Description

This endpoint requests for card payment

Parameters

Type Name Description Required Schema Default

BodyParameter

Card PaymentRequest

Payee, card details

true

CardPaymentRequest

Responses

HTTP Code Description Schema

200

Payment

CardPaymentResponse

default

Unexpected error

GeneralResponse

Tags

  • request payment

5039135918Request card payment status

POST /payment/status

Description

This endpoint requests the status of a previously submitted card payment request

Parameters

Type Name Description Required Schema Default

BodyParameter

Card Status Request

3rd party reference id or gateway transaction id

true

CardStatusRequest

807-265-3680Responses

HTTP Code Description Schema

200

Payment status

512-723-2419

default

Unexpected error

307-462-8798

(313) 676-1749Tags

  • request payment status

3653254022Request to revoke a token

POST /payment/token/cancel

Description

This endpoint revokes a card token by the reference id

Parameters

Type Name Description Required Schema Default

BodyParameter

Cancellation Request

Card details

false

TokenCancellationRequest

Responses

HTTP Code Description Schema

200

Cancellation status

TokenCancellationResponse

default

Unexpected error

4102650521

Tags

  • revoke token

Request card token

POST /payment/token/create

979-458-6470Description

This endpoint requests for card token

Parameters

Type Name Description Required Schema Default

BodyParameter

Card Request

Payee, card details

true

angelicalness

(913) 547-4743Responses

HTTP Code Description Schema

200

Payment status

CardTokenResponse

default

Unexpected error

GeneralResponse

Tags

  • request payment token

Definitions

(418) 394-7777CardPaymentRequest

Name Description Required Schema Default

token

A unique token number

false

string

amount

The amount payable

false

number

referenceId

A transaction reference identification number

false

string

merchantId

A unique identifier to access card payments online

false

string

CardPaymentResponse

Name Description Required Schema Default

cardNumber

the card number used for payment.

false

string

status

the status of the request success is the default where ok

false

string

message

the message displayed when payment is a success

false

string

code

the status code of the request 0 is successful.

false

string

referenceId

A transaction reference number

false

string

CardStatusRequest

Name Description Required Schema Default

referenceId

A unique transaction reference number

false

string

CardStatusResponse

Name Description Required Schema Default

status

the status of the request success is the default where ok

false

string

message

the message displayed when payment is a success

false

string

code

the status code of the request 0 is successful.

false

string

warning

message displayed as warning

false

string

statusCode

status code of the request

false

string

CardTokenRequest

Name Description Required Schema Default

amount

The amount payable

false

number

cardNumber

the card number in the format 544878*572.

false

string

cardExpiry

The month and year that the card will expire in the format mmyy

false

string

cardSecurityCode

A unique security code

false

string

email

A valid email address

false

string

referenceId

A unique transaction reference number

false

string

merchantId

A unique identifier to access card payments online

false

string

(202) 461-5959CardTokenResponse

Name Description Required Schema Default

token

A unique token number generated by the gateway

false

string

cardNumber

the card number used for payment.

false

string

status

the status of the request success is the default where ok

false

string

message

the message displayed when token creation is a success

false

string

code

the status code of the request 0 is successful.

false

string

referenceId

A transaction reference number

false

string

(833) 299-0616GeneralResponse

Name Description Required Schema Default

card

false

string

status

false

string

message

false

string

code

false

string

referenceId

false

string

TokenCancellationRequest

Name Description Required Schema Default

token

A unique token number

false

string

referenceId

A transaction reference identification number

false

string

snakilyTokenCancellationResponse

Name Description Required Schema Default

status

the status of the request success is the default where ok

false

string

message

the message displayed when token cancellation is a success

false

string

code

the status code of the request 0 is successful

false

string

TransactionStatusRequest

Name Description Required Schema Default

amount

the amount payable

false

number

token

A unique token identifier

false

string

referenceId

A transaction reference number

false

string