Pay Order

Detailed documentation on how to complete payment of an order

Good to know: To complete payment using any of the payment methods, RSA encryption PKCS#1 v1.5 is used to encrypt the payload with any of the payment methods selected then the complete pay order API is called.

The payload for each of the encrypt steps can be done using the RSA Algorithm defined without calling the encrypt endpoint. The encrypt data api will be deprecated.

Pay with card

Encrypt card payment data

POST https://localhost/checkout/data/encrypt

Creates a new card payment order, and returns the encrypted data.

Headers

Name

Type

Description

api-key*

String

public api key

Request Body

Name

Type

Description

reference*

string

unique payment reference

payment_option*

string

for card payment pass C

country*

string

country of payment

card.cvv*

string

cvv for card being used for payment

card.expiry_year*

String

expiry year of card

card.expiry_month*

String

expiry month of card

card.card_number*

String

card number

{
    "data": "adMeady/dFZjx2Rrty9Mn3yAJhD1eXNtTn3PzYD9H05Rx+oVohkEaovvAKGARvOmIrsLZ6Oi9KnYx+9hmyG/YEn1W5v833QyCUN34NaRjEz8YZAccEvk5n6ZJziwdAOzN3yo4gWUliN37alO2afn2QDZ8KfhFPh7+oXRBnYae4l9hTX6pWJHb4oahp36lfoK04XCRDhgFCgerqrCIkZQ/5FWbecpfsf7dSDTTqJLWqk+8AXghwq0sku20Izc15ShU0KMKiYBPIhSsFMa6j5g5STFtVRgrPxDnyrdTue6ANc1o1iL04bpB3nFz43scwvPEsdqnux94wuyDEldbCMdL542h+ZyLTpUOKu32IMIDGRBepSTaWNEz9q7A+ez0XXZNlK+JYHJZBitiPzaQla/mLvAC7fKrl0XvBVrL9bLz+AbOfYKrDY04LC5ADBacJ3FiRCTNLmiswRauUDCdo7DBkkEeL85eeg8E32i+xxnqUpkSGsxO69g7jNVKvsoHSCjO2ZYo+QIKSMuMU+5q46ipYXvHmjKJgPbvuG6R1SoFRoY/ATQEEe0WgPiO1tRVkLm/23wKlBu/uEKNeODBxtkG2U9vdzVE0oYmcXVWXi4WoCPpzZ9xNfaXqn26VfHzPaVwPSw9D4Y5s/7tA6H+FmR7lbqzcjdOlkCH/5kFSTnCwc="
}

Pay with bank transfer

Encrypt bank transfer data

POST https://localhost/checkout/data/encrypt

pay with bank transfer

Headers

Name

Type

Description

api-key*

String

public api key

Request Body

Name

Type

Description

payment_option*

String

pass BT for bank transfer

reference*

String

unique reference

{
    "data": "aTxxuN2JesF8F1LUGV+ZIiD9zSOtpYA4bpe6M+9tulrLkkfkDu7I7lE3Gnvu3Q/b2MfxtYTS7YU9P1Y/M0OarzOP1085LcGwMNjAb70+frOPCavv4sRiJoChNRlaX9nvFwR7Vk248aSYF3kpOUMx6PGijJgOpnH+qa9UwNIPSJzQtC3ZFTR3VYJ0qRaBDgoaz/4nUcey0om1PnueX0EbPKwM1jbH+OaF/hbbK818iO6BCLVs/jQ7f643dA29HgMhDN3tUnNLZdLHvw/M22wUZBByf1J/zbI4scEUA+cmO5H3xfn166EeI/BSXXnOtduJuLA+7HF7yB8J6whTcbf3c+5acKMNEKQEXnvHBFWX2rcFIE+QouBYNiCCGnMWKDLL5GPmQHOeNuiEkMyfMS0ovzxa7j82oYM0jhoGJByL9RD6QXPYvLljL/+rVBbcquc12K7anRPjzzrlSOMBz7/HErtWn4UeU4Tbo1WORa6Z+aDG7OtA8FWVHBb3dvD/uw6jFo9tI2lRIVfEHgGx4vF7Pw/F7S9ELxgZaUfD0hZG/RsGBccMXQD1Qp3n5AIq24+sLqHL6JWW3y6ZxHpNoZPZ1ldlvJNv9hRMyQrU9IOjQiHoxJDLhL3Dik5Qgd9QzDf1Qmgt7m1xHWpcJSOwgn0Is8Q/zpr/GtzK1umiS+hdb6s="
}

Pay with Mobile Money

Pay with MOMO

POST https://localhost/checkout/data/encrypt

complete payment using Mobile money

Headers

Name

Type

Description

api-key*

String

public api key

Request Body

Name

Type

Description

reference*

String

unique reference for order

payment_option*

String

pass MOMO for mobile money payments

mobile_money.mobile_number*

String

mobile number to complete payment

{
    "data": "W3I2gRdzalanK4L5faRizAiwU/LH/x06DGFcVcToGxzBKV9xhVQsXzlV6RoOqwZ/SHSAwmKlWAcMDObWWlU0jI1apNuQ0WouIqJ3lFoJR5Rg39OJOhJuSK80cGcnh3Ff3f5F4kjyiJHqERzSjH87TCkiEBtnFfz+/L6TdIHdhCJe09ED9TzmupYkdTiVmGJRpITFOpD8VZUzx0uRKa7AKRCtpiz/DPV56b7nqK4p4I59t+vc87xwYtUovILamyNOUT3RMqzBQhNDNJjfcgJjT8LjWKHJS2LM+HF/cHj77QjQaKVtitNaOkGPxZj5wCZr31eqHASMsAp08MdfDqFqvxo0i9S+PkxlPubaP8f/YLhvMpBIFIZWVWfFigXnlWPUWNBIS0WJFUbWpuLNjMy9zTlAzxp302H4e+6nCf0wzo3gsvvqBtitAgZqfMZZHEBMkObHhpRBbM0UmOvq7f413gQqOnXfQCa7pqr0eJh5loWp4Sj6n2B53dJsW/6R+JU9QyZll1ecFaWLJvvIxnXGXb7LGu+yUp/13XrCkhmrsYxyz9in3iS3OKw7i4Dtf4gMlQyuISJYU7/NC1eUSgQDT5gcvjJMIP8yexFPe0KikTs2kwVKSumQ9z5LVLjDoozyKMeEbXHTvM+iFSBpOjg6otnk1pyJ5SUsVJKpVqFAEDM="
}

Pay with bank account

Get banks

GET https://localhost/checkout/banks

Get banks available for bank account payment

{
    "data": [
        {
            "bank_name": "ALAT by WEMA",
            "id": "035A",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.6893+00:00"
        },
        {
            "bank_name": "ASO Savings and Loans",
            "id": "401",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.962268+00:00"
        },
        {
            "bank_name": "Abbey Mortgage Bank",
            "id": "801",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.27919+00:00"
        },
        {
            "bank_name": "Access Bank",
            "id": "044",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.414214+00:00"
        },
        {
            "bank_name": "Access Bank (Diamond)",
            "id": "063",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.552319+00:00"
        },
        {
            "bank_name": "Amju Unique MFB",
            "id": "50926",
            "is_active": true,
            "created_date": "2021-08-31T20:41:27.824218+00:00"
        },
        {
            "bank_name": "Bainescredit MFB",
            "id": "51229",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.102194+00:00"
        },
        {
            "bank_name": "Bowen Microfinance Bank",
            "id": "50931",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.242566+00:00"
        },
        {
            "bank_name": "CEMCS Microfinance Bank",
            "id": "50823",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.51725+00:00"
        },
        {
            "bank_name": "Carbon",
            "id": "565",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.379201+00:00"
        },
        {
            "bank_name": "Citibank Nigeria",
            "id": "023",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.654183+00:00"
        },
        {
            "bank_name": "Coronation Merchant Bank",
            "id": "559",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.789236+00:00"
        },
        {
            "bank_name": "Ecobank Nigeria",
            "id": "050",
            "is_active": true,
            "created_date": "2021-08-31T20:41:28.924224+00:00"
        },
        {
            "bank_name": "Ekondo Microfinance Bank",
            "id": "562",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.070728+00:00"
        },
        {
            "bank_name": "Eyowo",
            "id": "50126",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.212266+00:00"
        },
        {
            "bank_name": "FSDH Merchant Bank Limited",
            "id": "501",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.894374+00:00"
        },
        {
            "bank_name": "Fidelity Bank",
            "id": "070",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.347251+00:00"
        },
        {
            "bank_name": "Firmus MFB",
            "id": "51314",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.484229+00:00"
        },
        {
            "bank_name": "First Bank of Nigeria",
            "id": "011",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.622245+00:00"
        },
        {
            "bank_name": "First City Monument Bank",
            "id": "214",
            "is_active": true,
            "created_date": "2021-08-31T20:41:29.757189+00:00"
        },
        {
            "bank_name": "Globus Bank",
            "id": "00103",
            "is_active": true,
            "created_date": "2021-08-31T20:41:30.032307+00:00"
        },
        {
            "bank_name": "GoMoney",
            "id": "100022",
            "is_active": true,
            "created_date": "2021-08-31T20:42:26.429357+00:00"
        },
        {
            "bank_name": "Guaranty Trust Bank",
            "id": "058",
            "is_active": true,
            "created_date": "2021-08-31T20:42:26.5751+00:00"
        },
        {
            "bank_name": "Hackman Microfinance Bank",
            "id": "51251",
            "is_active": true,
            "created_date": "2021-08-31T20:42:26.712025+00:00"
        },
        {
            "bank_name": "Hasal Microfinance Bank",
            "id": "50383",
            "is_active": true,
            "created_date": "2021-08-31T20:42:26.844004+00:00"
        },
        {
            "bank_name": "Heritage Bank",
            "id": "030",
            "is_active": true,
            "created_date": "2021-08-31T20:42:26.979149+00:00"
        },
        {
            "bank_name": "Ibile Microfinance Bank",
            "id": "51244",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.127124+00:00"
        },
        {
            "bank_name": "Infinity MFB",
            "id": "50457",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.267175+00:00"
        },
        {
            "bank_name": "Jaiz Bank",
            "id": "301",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.399227+00:00"
        },
        {
            "bank_name": "Keystone Bank",
            "id": "082",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.539027+00:00"
        },
        {
            "bank_name": "Kredi Money MFB LTD",
            "id": "50200",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.677139+00:00"
        },
        {
            "bank_name": "Kuda Bank",
            "id": "50211",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.815276+00:00"
        },
        {
            "bank_name": "Lagos Building Investment Company Plc.",
            "id": "90052",
            "is_active": true,
            "created_date": "2021-08-31T20:42:27.954054+00:00"
        },
        {
            "bank_name": "Links MFB",
            "id": "50549",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.092042+00:00"
        },
        {
            "bank_name": "Mayfair MFB",
            "id": "50563",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.22923+00:00"
        },
        {
            "bank_name": "Mint MFB",
            "id": "50304",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.372185+00:00"
        },
        {
            "bank_name": "Paga",
            "id": "100002",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.510091+00:00"
        },
        {
            "bank_name": "PalmPay",
            "id": "999991",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.64729+00:00"
        },
        {
            "bank_name": "Parallex Bank",
            "id": "526",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.784041+00:00"
        },
        {
            "bank_name": "Parkway - ReadyCash",
            "id": "311",
            "is_active": true,
            "created_date": "2021-08-31T20:42:28.923124+00:00"
        },
        {
            "bank_name": "Paycom",
            "id": "999992",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.06215+00:00"
        },
        {
            "bank_name": "Petra Mircofinance Bank Plc",
            "id": "50746",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.202169+00:00"
        },
        {
            "bank_name": "Polaris Bank",
            "id": "076",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.342127+00:00"
        },
        {
            "bank_name": "Providus Bank",
            "id": "101",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.482072+00:00"
        },
        {
            "bank_name": "Rand Merchant Bank",
            "id": "502",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.62728+00:00"
        },
        {
            "bank_name": "Rubies MFB",
            "id": "125",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.764167+00:00"
        },
        {
            "bank_name": "Sparkle Microfinance Bank",
            "id": "51310",
            "is_active": true,
            "created_date": "2021-08-31T20:42:29.909132+00:00"
        },
        {
            "bank_name": "Stanbic IBTC Bank",
            "id": "221",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.055375+00:00"
        },
        {
            "bank_name": "Standard Chartered Bank",
            "id": "068",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.192058+00:00"
        },
        {
            "bank_name": "Sterling Bank",
            "id": "232",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.332224+00:00"
        },
        {
            "bank_name": "Suntrust Bank",
            "id": "100",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.472136+00:00"
        },
        {
            "bank_name": "TAJ Bank",
            "id": "302",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.612046+00:00"
        },
        {
            "bank_name": "TCF MFB",
            "id": "51211",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.749156+00:00"
        },
        {
            "bank_name": "Titan Bank",
            "id": "102",
            "is_active": true,
            "created_date": "2021-08-31T20:42:30.887151+00:00"
        },
        {
            "bank_name": "Union Bank of Nigeria",
            "id": "032",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.027066+00:00"
        },
        {
            "bank_name": "United Bank For Africa",
            "id": "033",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.164015+00:00"
        },
        {
            "bank_name": "Unity Bank",
            "id": "215",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.29905+00:00"
        },
        {
            "bank_name": "VFD Microfinance Bank Limited",
            "id": "566",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.447245+00:00"
        },
        {
            "bank_name": "Wema Bank",
            "id": "035",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.589348+00:00"
        },
        {
            "bank_name": "Zenith Bank",
            "id": "057",
            "is_active": true,
            "created_date": "2021-08-31T20:42:31.727346+00:00"
        }
    ],
    "status": "success",
    "status_code": "00",
    "message": "Bank list fetched"
}

Encrypt bank account payment data

POST https://localhost/checkout/data/encrypt

complete payment using a bank account

Headers

Name

Type

Description

api-key*

String

public api key

Request Body

Name

Type

Description

bank_account.account_name*

String

account name for payment

bank_account.account_number*

String

account number for payment

bank_account.bank_code*

String

bank code for bank account used for payment

payment_option*

String

pass BA for bank account payment

reference*

String

unique reference for payment

{
    "data": "W3I2gRdzalanK4L5faRizAiwU/LH/x06DGFcVcToGxzBKV9xhVQsXzlV6RoOqwZ/SHSAwmKlWAcMDObWWlU0jI1apNuQ0WouIqJ3lFoJR5Rg39OJOhJuSK80cGcnh3Ff3f5F4kjyiJHqERzSjH87TCkiEBtnFfz+/L6TdIHdhCJe09ED9TzmupYkdTiVmGJRpITFOpD8VZUzx0uRKa7AKRCtpiz/DPV56b7nqK4p4I59t+vc87xwYtUovILamyNOUT3RMqzBQhNDNJjfcgJjT8LjWKHJS2LM+HF/cHj77QjQaKVtitNaOkGPxZj5wCZr31eqHASMsAp08MdfDqFqvxo0i9S+PkxlPubaP8f/YLhvMpBIFIZWVWfFigXnlWPUWNBIS0WJFUbWpuLNjMy9zTlAzxp302H4e+6nCf0wzo3gsvvqBtitAgZqfMZZHEBMkObHhpRBbM0UmOvq7f413gQqOnXfQCa7pqr0eJh5loWp4Sj6n2B53dJsW/6R+JU9QyZll1ecFaWLJvvIxnXGXb7LGu+yUp/13XrCkhmrsYxyz9in3iS3OKw7i4Dtf4gMlQyuISJYU7/NC1eUSgQDT5gcvjJMIP8yexFPe0KikTs2kwVKSumQ9z5LVLjDoozyKMeEbXHTvM+iFSBpOjg6otnk1pyJ5SUsVJKpVqFAEDM="
}

Pay with USSD

Encrypt USSD payment data

POST https://localhost/checkout/data/encrypt

complete USSD payment

Headers

Name

Type

Description

api-key*

String

public key for payment

Request Body

Name

Type

Description

payment_option*

String

pass USSD for USSD payment

reference*

String

unique reference for payment

{
    "data": "adMeady/dFZjx2Rrty9Mn3yAJhD1eXNtTn3PzYD9H05Rx+oVohkEaovvAKGARvOmIrsLZ6Oi9KnYx+9hmyG/YEn1W5v833QyCUN34NaRjEz8YZAccEvk5n6ZJziwdAOzN3yo4gWUliN37alO2afn2QDZ8KfhFPh7+oXRBnYae4l9hTX6pWJHb4oahp36lfoK04XCRDhgFCgerqrCIkZQ/5FWbecpfsf7dSDTTqJLWqk+8AXghwq0sku20Izc15ShU0KMKiYBPIhSsFMa6j5g5STFtVRgrPxDnyrdTue6ANc1o1iL04bpB3nFz43scwvPEsdqnux94wuyDEldbCMdL542h+ZyLTpUOKu32IMIDGRBepSTaWNEz9q7A+ez0XXZNlK+JYHJZBitiPzaQla/mLvAC7fKrl0XvBVrL9bLz+AbOfYKrDY04LC5ADBacJ3FiRCTNLmiswRauUDCdo7DBkkEeL85eeg8E32i+xxnqUpkSGsxO69g7jNVKvsoHSCjO2ZYo+QIKSMuMU+5q46ipYXvHmjKJgPbvuG6R1SoFRoY/ATQEEe0WgPiO1tRVkLm/23wKlBu/uEKNeODBxtkG2U9vdzVE0oYmcXVWXi4WoCPpzZ9xNfaXqn26VfHzPaVwPSw9D4Y5s/7tA6H+FmR7lbqzcjdOlkCH/5kFSTnCwc="
}

Complete Pay Order

after encrypting data for any of the payment methods, the pay order API is called to complete the payment

Pay order

POST https://localhost/checkout/order/pay

Pay for the order using the encrypted data

Headers

Name

Type

Description

api-key*

String

public api key

Request Body

Name

Type

Description

data*

String

encrypted data returned from the encrypt data endpoint

{
    "data": {
        "card": null,
        "payment_detail": null,
        "bank_transfer_details": {
            "bank_account": "9977573818",
            "account_name": "Tech Dev5",
            "bank_name": "Providus Bank"
        },
        "order_payment": {
            "order_id": 1218,
            "order_payment_reference": "PA-REF-016E9E61-AD49-441D-8D24-C2D6824CF892",
            "currency": "NGN",
            "status_id": 1,
            "order_payment_response_code": "01",
            "order_payment_response_message": "Initiated",
            "order_payment_instrument": "9977573818",
            "remarks": "Order payment initiated",
            "total_amount": 131.5904,
            "fee": 18.1504
        }
    },
    "status": "success",
    "status_code": "00",
    "message": "Please complete your order payment with this detail"
}

PreviousOrder Status

Last updated 3 years ago