☑️Process Withdraw

Withdrawal Endpoint

POST https://sandbox.pgecom.com/api/v1/withdraw

Headers

Name	Type	Description
authorization*	String	Bearer token

Request Body

Property	Type	Description
receiverEmail	string - required	Recipient's email address
amount	string - required	The amount to send to recipient. If you're sending htg as the currency, this is the amount of gourdes
type	string - default pgecom	Where you want to send the funds (PGecom, MonCash, NatCash, Sogebank, etc)
delivery	string - default instant	When do you want the funds to be available (standard, regular, express, urgent, instant)
currency	string - default usd	The currency that you'd like to send the funds to
message	string	A custom message for the recipient to receive
firstName	string	The first name of the recipient
lastName	string	The last name of the recipient
accountNumber	string	The bank account number
accountName	string	The account name
routingNumber	string	The routing account if any
accountType	string	The bank account type if any
address	string	The recipient address if any
webhookUrl	string	The url that you'd like to receive a withdraw is successful
metadata	object	You can pass additional values if you need to receive it once the order is complete

200: OK

{
    "newBalance": 638.64,
    "sender": "[e-mail]",
    "receiver": "[e-mail]",
    "orderId": "a1d52cce-2f80-448f-bfe8-b9c95ed1f2db",
    "amount": 5,
    "gourdes": 660,
    "userFee": 0.15,
    "userID": "5f56dfa3-a415-4818-8275-44fc63ece3fd",
    "deliveryMethod": "standard",
    "transactionType": "moncash_withdraw",
    "currency": "usd",
    "status": "processing",
    "metadata": {
        "currency": "usd"
    },
    "id": "028ed5e0-30ae-43de-8e94-6254c55e8ccb",
    "platform": "pgrewards",
    "createdAt": "2024-06-03T22:47:35.538Z",
    "updatedAt": "2024-06-03T22:47:35.538Z",
    "delivery": "standard"
}