Skip to main content

Payout from Wallet

Endpoint for initiating a Payout from the Wallet.

info

Please be aware that this endpoint requires a Wallet API Key.

POST /api/v1/groups/{group_id}/revere_pay/{linked_account_id}/wallet/payout

Request Parameters

NameDescriptionTypeRequired
payment_method_idThe payment method id of the payout.stringRequired
amountThe amount of the payout.uint64Required
currencyThe currency of the payout. Possible value: USDstringRequired

Response

CodeDescription
200Success
400Bad Request / Validation error
500Internal Error

Example Usage

payout.js
var headers = new Headers();
headers.append('Authorization', 'API_KEY');

var requestOptions = {
method: 'POST',
headers: headers,
redirect: 'follow',
body: {
// request body data
}
};
const group_id = '';
const linked_account_id = '';
const url = `https://api.reverepayments.dev/api/v1/groups/${group_id}/revere_pay/${linked_account_id}/wallet/payout`,
fetch(
url,
requestOptions
)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));

Example Request

{
"payment_method_id": "23fe345e-3e5f-4c32-8220-50b96a0fd1e0",
"amount": 100000,
"currency": "USD"
}

Example Success Response

{
"processor_transaction_id": "a2b88fc2-fa43-4fbc-87fb-8309203affeb",
"amount": 100000,
"status": "settled",
"created_at": "2024-07-20T15:11:16.975339432Z"
}