Create Order

Detailed documentation on how to create an order

Creating a new order

Good to know: To create an order, first the order data must be encrypted before proceeding to create the order. payload should be encrypted using RSA encryption PKCS#1 v1.5.

Payload to be encrypted using RSA Algorithm

// Data to be encrypted
{
    "customer": {
        "first_name": "test",
        "last_name": "test",
        "mobile": "+2348101234566",
        "country": "NG",
        "email": "[email protected]"
    },
    "order": {
        "amount": 100,
        "reference": "ORD12DC89289033323",
        "description": "Pay",
        "currency": "NGN"
    }
}

Create order

POST https://localhost/checkout/order/create

create payment order

Headers

Name

Type

Description

api-key*

string

public api key

Request Body

Name

Type

Description

data*

string

encrypted data

{
    "data": {
        "order": {
            "reference": "ORD12DC89289033323806",
            "processor_reference": "PARORD-75F0BF09-BB5F-457A-95F4-FBAB5EF96D98",
            "order_payment_reference": "",
            "amount": 100,
            "fee": 0,
            "fee_rate": 0,
            "status_id": 1,
            "status": "Initiated",
            "currency": "NGN",
            "narration": "Pay"
        },
        "subsidiary": {
            "id": 0,
            "name": "Tech Dev5",
            "country": "NG",
            "support_email": "[email protected]",
            "customization": [
                {
                    "key": "logo",
                    "value": "https://payinvert-subsidiary-images.s3.us-east-2.amazonaws.com/payinvert-logo.png"
                }
            ]
        },
        "customer": {
            "email": "[email protected]",
            "first_name": "Leo",
            "last_name": "Mane",
            "mobile": "+234810123456",
            "country": "NG"
        },
        "payment": null,
        "other_payment_options": [
            {
                "code": "BT",
                "name": "Bank Transfer",
                "currency": "NGN"
            },
            {
                "code": "C",
                "name": "Card Payment",
                "currency": "NGN"
            },
            {
                "code": "BA",
                "name": "Bank Account",
                "currency": "NGN"
            },
            {
                "code": "USSD",
                "name": "USSD",
                "currency": "NGN"
            }
        ],
        "saved_cards": [
            {
                "saved_card_id": 1,
                "country": "UNITED KINGDOM GB",
                "card_expiry_month": "01/23",
                "card_expiry_year": "01/23",
                "card_first_six_digits": "455605",
                "card_last_four_digits": "2643",
                "card_type": "VISA",
                "card_issuer": " CREDIT",
                "date_created": "2022-05-07T04:59:08.21",
                "app_environment_id": 1
            }
        ],
        "subsidiary_order_summary": {
            "order_name": "Tech Dev5 Order ORD12DC89289033323806",
            "total_amount": 100,
            "reference": "ORD12DC89289033323806",
            "currency": "NGN",
            "order_items": [
                {
                    "name": "Summary",
                    "amount": 100
                }
            ]
        }
    },
    "status": "success",
    "status_code": "00",
    "message": "Created order successfully"
}

{
    "errors": {
        "Order.DescriptionOfOrder": [
            "The DescriptionOfOrder field is required."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "|f8d53306-42e2445da05de214.1.f8b827fb_"
}

{
    "errors": {
        "Order.Amount": [
            "The field Amount must be between 1 and 1000000."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "|f8d532f3-42e2445da05de214.1.f8b827f4_"
}

PreviousAPI Reference NextOrder Status

Last updated 3 years ago

{ "data": { "order": { "reference": "ORD12DC89289033323806", "processor_reference": "PARORD-75F0BF09-BB5F-457A-95F4-FBAB5EF96D98", "order_payment_reference": "", "amount": 100, "fee": 0, "fee_rate": 0, "status_id": 1, "status": "Initiated", "currency": "NGN", "narration": "Pay" }, "subsidiary": { "id": 0, "name": "Tech Dev5", "country": "NG", "support_email": "[email protected]", "customization": [ { "key": "logo", "value": "https://payinvert-subsidiary-images.s3.us-east-2.amazonaws.com/payinvert-logo.png" } ] }, "customer": { "email": "[email protected]", "first_name": "Leo", "last_name": "Mane", "mobile": "+234810123456", "country": "NG" }, "payment": null, "other_payment_options": [ { "code": "BT", "name": "Bank Transfer", "currency": "NGN" }, { "code": "C", "name": "Card Payment", "currency": "NGN" }, { "code": "BA", "name": "Bank Account", "currency": "NGN" }, { "code": "USSD", "name": "USSD", "currency": "NGN" } ], "saved_cards": [ { "saved_card_id": 1, "country": "UNITED KINGDOM GB", "card_expiry_month": "01/23", "card_expiry_year": "01/23", "card_first_six_digits": "455605", "card_last_four_digits": "2643", "card_type": "VISA", "card_issuer": " CREDIT", "date_created": "2022-05-07T04:59:08.21", "app_environment_id": 1 } ], "subsidiary_order_summary": { "order_name": "Tech Dev5 Order ORD12DC89289033323806", "total_amount": 100, "reference": "ORD12DC89289033323806", "currency": "NGN", "order_items": [ { "name": "Summary", "amount": 100 } ] } }, "status": "success", "status_code": "00", "message": "Created order successfully" }