Virtual Account Payment

Virtual Bank transfer

Initiate Dynamic Virtual Account Transaction

This API allows you to generate a Dynamic Virtual Account to be assigned to a customer. This is used to initiate a transaction.

Request Endpoint

https://api.pelpay.ng/Payment/process/banktransfer/:adviceReferenceapi.pelpay.ng

Request Body

{
  "bankCode": "035"
}

Response

Response Codes

• 200: Success

• 400: Bad Request

Response Body Example

{
  "requestSuccessful": true,
  "responseData": {
    "bankName": "Pelpay | Chams ltd",
    "bankCode": "035",
    "bankAccount": "8388485453",
    "paymentReference": "0866ac2d-dadc-40b0-a56f-a2eb7a1cc878",
    "status": "Processing",
    "message": "Processing",
    "amount": 6000,
    "amountPaid": 0,
    "callBackUrl": "https://your_callback_url.com/?adviceReference=ffe1a559-5d9e-47fe-85t7-042316478040&paymentReference=0866ac2d-dadc-40b0-a56f-a2rt7a1cc869",
    "customerName": "Chams Switch"
  },
  "message": "Successful",
  "responseCode": "00"
}

Simulate Payment Endpoint

To Simulate payment, ensure you pass the bearer token retrieved from the authentication login endpoint as the Authorization header to authenticate and authorize the request.

Request Headers:

• Authorization: Bearer {token}

This API allows you to push test transactions. Please note that this API is to be used only on the sandbox environment.

Endpoint:

https://api.pelpay.ng/Payment/process/banktransfer/simulate/paymentapi.pelpay.ng

Request Body:

{
    "virtualAccountNumber": "8388485453",
    "amount": "6000"
}

Response:

{
    "requestSuccessful": true,
    "responseData": {
        "bankName": "Pelpay | Chams ltd",
        "bankCode": "035",
        "bankAccount": "8388485453",
        "paymentReference": "c2ea27cbd3cf46f0af99395e0f25wtrs",
        "status": "Successful",
        "message": "Successful",
        "amount": 6000.00,
        "amountPaid": 6000,
        "callBackUrl": "https://your_callback_url.com?adviceReference=fe7b2373-e3c8-488b-a45b-94511a3e2120&paymentReference=c2ea27cbd3cf46f0af99395e0f25caed",
        "customerName": "Chams Switch"
    },
    "message": "Successful",
    "responseCode": "00"
}