Payout

Create a payout

Changed on

Use payouts to send money to your customers.

post/v1/payouts

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/payouts
  • Auth
    HTTP bearer

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Keystring

Optional client generated value to use for idempotent requests.

Request body

paykeystring required

Value of the paykey used for the payout.

descriptionstring nullable required

An arbitrary description for the payout.

amountinteger required

The amount of the payout in cents.

currencystring required

The currency of the payout. Only USD is supported.

payment_datestring date required

The desired date on which the payout should be occur. For payouts, this means the date you want the funds to be sent from your bank account.

external_idstring required

Unique identifier for the payout in your database. This value must be unique across all payouts.

metadataobject nullable

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the payout in a structured format.

Example request

{
  "description": "Vendor invoice payment",
  "device": {
    "ip_address": "192.168.1.1"
  }
}

Response

Created

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": {
    "customer_details": {
      "name": "Ron Swanson",
      "email": "ron@swanson.com",
      "phone": "+1234567890"
    },
    "paykey_details": {
      "label": "Bank of America ****1234"
    },
    "device": {
      "ip_address": "192.168.1.1"
    },
    "status_details": {
      "message": "Payment successfully created and awaiting validation."
    },
    "status_history": [
      {
        "message": "Payment successfully created and awaiting validation."
      }
    ]
  }
}

Changes

  • de39a60c562eRevision changes
    • breaking

      the / response's property type changed from object to array for status (media type: text/plain)

    • breaking

      the / response's property type changed from object to array for status (media type: application/json)

    • breaking

      the / response's property type changed from object to array for status (media type: text/json)

    • warning

      added the new failed_not_authorized enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new failed_not_authorized enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new failed_not_authorized enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new reversed_not_authorized enum value to the // response property for the response status (media type: text/plain)

    • warning

      added the new reversed_not_authorized enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new reversed_not_authorized enum value to the // response property for the response status (media type: text/json)

    • info

      added the new failed_not_authorized enum value to the request property / (media type: application/json)

    • info

      added the new failed_not_authorized enum value to the request property / (media type: text/json)

    • info

      added the new failed_not_authorized enum value to the request property / (media type: application/*+json)

    • info

      added the new reversed_not_authorized enum value to the request property / (media type: application/json)

    • info

      added the new reversed_not_authorized enum value to the request property / (media type: text/json)

    • info

      added the new reversed_not_authorized enum value to the request property / (media type: application/*+json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)

    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)

    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)

  • 940c74c551fcRevision changes
    • info

      removed the unknown enum value from the // response property for the response status (media type: text/plain)

    • info

      removed the unknown enum value from the // response property for the response status (media type: application/json)

    • info

      removed the unknown enum value from the // response property for the response status (media type: text/json)