---
updatedAt: 2025-09-22T23:13:21.000Z
agentTools:
  projectIndex: https://developers.conekta.com/v2.1.0/llms.txt
---

# Get Payout Order

Gets a payout Order resource that corresponds to a payout order ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "engineering@conekta.com",
      "name": "Engineering Conekta",
      "url": "https://github.com/conekta/openapi/issues"
    },
    "description": "Conekta sdk",
    "license": {
      "name": "MIT-LICENSE",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Conekta API",
    "version": "2.1.0"
  },
  "servers": [
    {
      "description": "Conekta main server",
      "url": "https://api.conekta.io"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/payout_orders/{id}": {
      "get": {
        "description": "Gets a payout Order resource that corresponds to a payout order ID.",
        "operationId": "getPayoutOrderById",
        "parameters": [
          {
            "description": "Identifier of the resource",
            "example": "6307a60c41de27127515a575",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Use for knowing which language to use",
            "examples": {
              "es": {
                "summary": "for spanish request/response",
                "value": "es"
              },
              "en": {
                "summary": "for english request/response",
                "value": "en"
              }
            },
            "in": "header",
            "name": "Accept-Language",
            "required": false,
            "schema": {
              "default": "es",
              "enum": [
                "es",
                "en"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.conekta-v2.1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/payout_order_response"
                }
              }
            },
            "description": "successful operation"
          },
          "401": {
            "content": {
              "application/vnd.conekta-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "Please include your access key in your request.",
                      "param": null,
                      "code": "conekta.errors.authentication.missing_key"
                    }
                  ],
                  "log_id": "507f1f77bcf86cd799439011",
                  "object": "error",
                  "type": "authentication_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "authentication error"
          },
          "404": {
            "content": {
              "application/vnd.conekta-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "The resource was not found.",
                      "param": null,
                      "code": "conekta.errors.resource_not_found.entity",
                      "debug_message": "The object Webhook \"641b1d5662d7e00001eaa46b\" could not be found."
                    }
                  ],
                  "log_id": "641b6c253cd9a50001514fae",
                  "object": "error",
                  "type": "resource_not_found_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "not found entity"
          },
          "500": {
            "content": {
              "application/vnd.conekta-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "debug_message": "There was a runtime error and Conekta engineers have been notified.",
                      "message": "There was a runtime error and Conekta engineers have been notified.",
                      "param": null,
                      "code": "conekta.errors.api.system.general_failure"
                    }
                  ],
                  "object": "error",
                  "type": "api_error",
                  "log_id": "641b6f2b3cd9a50001515098"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get Payout Order",
        "tags": [
          "Payout Orders"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "error": {
        "allOf": [
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "properties": {
              "log_id": {
                "description": "log id",
                "example": "507f1f77bcf86cd799439011",
                "nullable": true,
                "type": "string"
              },
              "type": {
                "example": "authentication_error",
                "type": "string"
              },
              "object": {
                "example": "error",
                "type": "string"
              }
            },
            "type": "object"
          }
        ],
        "description": "err model",
        "title": "error"
      },
      "payout_order_response": {
        "description": "payout order model response",
        "properties": {
          "allowed_payout_methods": {
            "description": "The payout methods that are allowed for the payout order.",
            "example": [
              "cashout"
            ],
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          },
          "amount": {
            "description": "The amount of the payout order.",
            "example": 100,
            "type": "integer"
          },
          "created_at": {
            "description": "The creation date of the payout order.",
            "example": 1677626837,
            "format": "int64",
            "type": "integer"
          },
          "currency": {
            "default": "MXN",
            "description": "The currency in which the payout order is made.",
            "example": "MXN",
            "type": "string"
          },
          "customer_info": {
            "$ref": "#/components/schemas/payout_order_response_customer_info"
          },
          "expires_at": {
            "description": "The expiration date of the payout order.",
            "example": 1677626837,
            "format": "int64",
            "type": "integer"
          },
          "id": {
            "description": "The id of the payout order.",
            "example": "f2654d66-d740-457a-9a8c-f96b5196f44e",
            "type": "string"
          },
          "livemode": {
            "description": "The live mode of the payout order.",
            "example": true,
            "type": "boolean"
          },
          "object": {
            "description": "The object of the payout order.",
            "example": "payout_order",
            "type": "string"
          },
          "metadata": {
            "additionalProperties": true,
            "description": "The metadata of the payout order.",
            "example": {
              "custom_client_id": "12345"
            },
            "maxProperties": 100,
            "type": "object"
          },
          "payouts": {
            "description": "The payout information of the payout order.",
            "items": {
              "$ref": "#/components/schemas/payout_order_payouts_item"
            },
            "title": "payout_order_payouts",
            "type": "array"
          },
          "reason": {
            "description": "The reason for the payout order.",
            "example": "Payout order for the customer",
            "type": "string"
          },
          "status": {
            "description": "The status of the payout order.",
            "example": "open",
            "type": "string"
          },
          "updated_at": {
            "description": "The update date of the payout order.",
            "example": 1677626837,
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "allowed_payout_methods",
          "amount",
          "created_at",
          "currency",
          "customer_info",
          "id",
          "livemode",
          "object",
          "payouts",
          "reason",
          "updated_at"
        ],
        "title": "payout_order_response",
        "type": "object"
      },
      "details": {
        "properties": {
          "details": {
            "items": {
              "$ref": "#/components/schemas/details_error"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "order_customer_info_response": {
        "properties": {
          "customer_custom_reference": {
            "description": "Custom reference",
            "example": "custom_reference",
            "nullable": true,
            "type": "string"
          },
          "name": {
            "example": "DevTest",
            "type": "string"
          },
          "email": {
            "example": "test@conekta.com",
            "format": "email",
            "type": "string"
          },
          "phone": {
            "example": "5522997233",
            "type": "string"
          },
          "corporate": {
            "default": false,
            "type": "boolean"
          },
          "object": {
            "example": "customer_info",
            "type": "string"
          }
        },
        "title": "order_customer_info_response",
        "type": "object"
      },
      "payout_order_response_customer_info": {
        "allOf": [
          {
            "properties": {
              "id": {
                "description": "The id of the customer.",
                "example": "cus_23874283647",
                "type": "string"
              }
            },
            "required": [
              "id"
            ],
            "type": "object"
          },
          {
            "$ref": "#/components/schemas/order_customer_info_response"
          }
        ],
        "description": "The customer information of the payout order."
      },
      "payout_order_payouts_item": {
        "properties": {
          "amount": {
            "description": "The amount of the payout.",
            "example": 3000,
            "type": "integer"
          },
          "currency": {
            "description": "The currency in which the payout is made.",
            "example": "MXN",
            "type": "string"
          },
          "expires_at": {
            "description": "The expiration date of the payout.",
            "example": 1677626837,
            "format": "int64",
            "type": "integer"
          },
          "id": {
            "description": "The id of the payout.",
            "example": "payout_2vZwsRAhhGp2dFDJx",
            "type": "string"
          },
          "livemode": {
            "description": "The live mode of the payout.",
            "example": true,
            "type": "boolean"
          },
          "object": {
            "description": "The object of the payout.",
            "example": "payout",
            "type": "string"
          },
          "payout_order_id": {
            "description": "The id of the payout order.",
            "example": "f2654d66-d740-457a-9a8c-f96b5196f44e",
            "type": "string"
          },
          "status": {
            "description": "The status of the payout.",
            "example": "open",
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "id",
          "livemode",
          "object"
        ],
        "title": "payout_order_payouts_item",
        "type": "object"
      },
      "details_error": {
        "properties": {
          "code": {
            "example": "conekta.errors.authentication.missing_key",
            "type": "string"
          },
          "param": {
            "nullable": true,
            "type": "string"
          },
          "message": {
            "example": "Acceso no autorizado.",
            "type": "string"
          },
          "debug_message": {
            "example": "Please include your access key in your request.",
            "type": "string"
          }
        },
        "title": "details_error",
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```