Browpay API Documentation
  • Home
  • Escrow QuickStart Guide
  • Authentication
  • Webhooks
    • Signature Validation
    • Encryption and Decryption
  • Payments
    • Collect Payments
      • Initialize Transaction
      • Verify Payments
      • List Payments
    • Transaction Codes
      • Verify Token
      • List Codes
  • Payouts
    • Account Resolution
    • Transfers
      • Create Transfer
      • Fetch Transfer
      • List Transfers
  • Customers
    • Fetch Customers
    • Load Customer
  • Products
    • Fetch Products
  • Miscellaneous
    • Balances
    • Banks
    • Countries
  • Plugins
    • Plugins and Libraries
Powered by GitBook
On this page
  • Overview
  • Our system flow in four simple steps:

Was this helpful?

Escrow QuickStart Guide

PreviousHomeNextAuthentication

Last updated 4 months ago

Was this helpful?

He who rushes to the marketplace doubting every bargain often leaves with empty hands and a heavy heart; says an African Proverb However, with Browpay He has a better chance of unburdening the heavy heart by trusting that we will keep his heart safe, and his money safer. 😇

Overview

Here is an overview of how the Browpay escrow system works:

We are similar to what you would call your ecommerce transaction brokers. Our interest lies in faster sales for your products and safer purchases for your buyers.

With the Browpay API, you can:

- create secure escrow payment checkouts

- access your real-time balances,

- manage your product inventory,

- gain access to your customer information for easy marketing and reach.

Trust that we are working hard to improve on what you can do with our API and we will duly notify you as we develop over time.

Our system flow in four simple steps:

  1. Your customer makes an order right within your website or mobile application

  2. We respond with a dynamic and secured authorization link. Please Note: the links are invalidated within 5 minutes after it is generated and you cannot issue same reference on duplicate authorization links.

  3. Your customer makes payment.

  4. We verify the payment either internally, through your callback URL(if provided) and via our webhook notifications to your webhook URL.

  5. We credit your holding balance on notice of a successful transaction.

This step shows how we handle the third-party verification after payment has been confirmed.

  1. Seller Processes Value Delivery and

  2. Your customer receives a secured transaction code (Payment token) that secures the transaction.

Step 3 happens after the transaction verification and value delivery have been completed by the customer while expiry duration is valid;

We only execute Step 4 on expiry if the transaction is not resolved before expiry.

It means if your customer does not verify the value delivery by releasing the token or using the verification link, we will automatically pay you (the seller) on the expiry day as defined in Step 1

  1. The customer releases the Transaction Code (Payment Token) received in Step 2 to the seller or visits the verification link we sent to the customer (Via email or SMS) as at when the payment was made.

  2. We settle the seller's wallet instantly if the code/token is valid.

SHOULD THE CUSTOMER NOT VERIFY/VALIDATE THE TRANSACTION as stated in Step 3.

  1. Our system will automatically send a reminder notification of expiry for that particular transaction. And

  2. Our system will automatically settle the seller and credit the Wallet in the next 6 hours after (Point 1).

Our system expects a payload of requests that includes, the products and its description, your customer information and a (duration of expiry) for that transaction see endpoint for a full list of required information.

The seller queries/checks/redeems the code/token for that transaction using the Endpoint and

Browpay Support will only step in to the transaction should an issue be escalated and resolution is bound to happen in less than 48 hours before expiry. Check out our to learn how we handle escalations.

Initialize Transaction
Verify Token
Escrow Policy
System Flow - Step 1
System Flow - Step 2
System Flow - Step 3