Payout Request

Initiate a payout request to send funds to a customer.

Endpoint Information

Name: Make Payout Request
Method: POST
URL: {{base_url}}/api/v1/payout/request

Description

Create a request to pay out funds to a recipient. This can be processed via card or bank transfer depending on the configuration and parameters.

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Request Body

Content-Type: application/json

{
  "merchantAccountId": "{{your_account_no}}",
  "reference": "ref-0001",
  "country": "Sweden",
  "dob": "1994-12-21",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "contactNumber": "+01234567890",
  "postcode": "12345",
  "premise": "1234",
  "street": "Unnamed Road",
  "state": "Blekinge",
  "town": "Kallinge",
  "amount": "45",
  "currency": "USD",
  "payoutType": "",        // optional: cardPayout or bankPayout
  "solutionId": "f0850594-efc0-449b-b0ab-7ada65dcd56a", // optional
  "webhookUrl": "{{webhookUrl}}" // optional
}

Key Parameters

Parameter	Type	Required	Description
reference	string	Yes	Unique reference (min 10 chars, no special chars)
amount	string	Yes	Payout amount
currency	string	Yes	Currency code (ISO 4217)
firstName	string	Yes	Recipient first name
lastName	string	Yes	Recipient last name
payoutType	string	No	cardPayout or bankPayout
solutionId	string	No	Specific solution to use

Response

Success Response

{
  "success": true,
  "message": "Payout request created successfully",
  "data": {
    "payout_url": "https://sgw.paymid.com/secure-payout/c32b46f8-d9b1-482f-b596-4c3a4f227426",
    "reference": "ref-5001"
  }
}

Usage

Redirect the user to the payout_url to complete any necessary verification or details entry.