Bank Payout

Process a payout directly to a bank account.

Endpoint Information

Name: Make Bank Payouts
Method: POST
URL: {{base_url}}/api/v1/payout/process

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Request Body

Content-Type: application/json

{
  "basicProfile": {
    "country": "Sweden",
    "dob": "2024-04-01",  // optional but format must be yyyy-mm-dd if present
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "contactNumber": "9034893274",
    "postcode": "11115",
    "town": "Borlänge"
    // ...other profile fields
  },
  "processorRequiredFields": {
    "accountName": "John Doe",
    "accountNumber": "5648915103",
    "bankName": "SIAM COMMERCIAL BANK",
    "bankCode": "014"
  },
  "reference": "papaya-123q",
  "merchantAccountId": "{{your_account_no}}",
  "amount": "10",
  "currency": "THB",
  "solutionId": "{{solutionId}}",
  "payoutType": "bankPayout" // Required
}

Key Parameters

Parameter	Type	Required	Description
processorRequiredFields	object	Yes	Fields specific to the bank/processor
payoutType	string	Yes	Must be bankPayout
solutionId	string	Yes	The ID of the solution processing the payment

Response

Success Response

{
  "success": true,
  "message": "Bank Payout Processed",
  "data": {
    "success": true,
    "reference_id": "55-DuqXNBv0Q7",
    "redirect_to": null
  }
}