Single Payout

Endpoint: POST /payout/simple

This endpoint creates a simple payout for a specified beneficiary.

Request

• URL: /payout/simple

• Method: POST

• Headers:

  • Content-Type: application/json

  • Authorization: Bearer {token}

Request Body

• beneficiary_id: (integer, required) The ID of the beneficiary.

• amount: (numeric, required) The amount to be paid out.

• beneficiary_details_id: (integer, required) The ID of the beneficiary's details.

Payload Example

{
    "beneficiary_id": 1,
    "amount": 38,
    "beneficiary_details_id": 1 
}

Validation Error Response

• Status: 400 Bad Request

• Body:

  {
      "status": "failed",
      "status_code": 400,
      "message": "Request failed",
      "data": {
          "beneficiary_id": [
              "The beneficiary id field is required."
          ],
          "amount": [
              "The amount field is required."
          ],
          "beneficiary_details_id": [
              "The beneficiary details id field is required."
          ]
      }
  }

Success Response

• Status: 200 OK

• Body:

  {
      "status": "success",
      "status_code": 200,
      "message": "Request successful",
      "data": {
          "user_id": 1,
          "amount": "15",
          "currency": "PEN",
          "beneficiary_id": "1",
          "status": "pending",
          "created_at": "2024-05-30T20:53:30.000000Z",
          "updated_at": "2024-05-30T20:53:38.000000Z",
          "payout_id": "145ed2e4-178e-4347-a1ad-3b3899a06e70",
          "beneficiary": {
              "id": 1,
              "user_id": 1,
              "recipient_type": "individual",
              "customer_name": "John Smith",
              "customer_email": "[e-mail]",
              "customer_nickname": "John Smith",
              "country": "Nigeria",
              "customer_address": {
                  "city": "Ikeja",
                  "county": "Lagos",
                  "postal_code": 900901,
                  "address_line_1": "1st episode john doe street",
                  "address_line_2": "this can be null"
              },
              "created_at": "2024-05-08T13:47:11.000000Z",
              "updated_at": "2024-05-08T13:47:11.000000Z"
          }
      }
  }

Explanation

1. status: Indicates whether the request was successful or failed.

2. status_code: The HTTP status code of the response.

3. message: A message indicating the result of the request.

4. data: An object containing details about the payout, including:

   • user_id: The ID of the user who initiated the payout.

   • amount: The amount of the payout.

   • currency: The currency of the payout.

   • beneficiary_id: The ID of the beneficiary.

   • status: The current status of the payout.

   • created_at: The timestamp when the payout was created.

   • updated_at: The timestamp when the payout was last updated.

   • payout_id: The unique identifier for the payout.

   • beneficiary: An object containing details about the beneficiary, including:

     • id: The ID of the beneficiary.

     • user_id: The ID of the user associated with the beneficiary.

     • recipient_type: The type of recipient (e.g., individual).

     • customer_name: The name of the beneficiary.

     • customer_email: The email of the beneficiary.

     • customer_nickname: The nickname of the beneficiary.

     • country: The country of the beneficiary.

     • customer_address: An object containing the address of the beneficiary, including:

       • city: The city of the beneficiary.

       • county: The county of the beneficiary.

       • postal_code: The postal code of the beneficiary.

       • address_line_1: The first line of the address.

       • address_line_2: The second line of the address (can be null).

     • created_at: The timestamp when the beneficiary was created.

     • updated_at: The timestamp when the beneficiary was last updated.