Get payin by ID | Root API

{
  "data": {
    "id": "789e0123-e89b-12d3-a456-426614174000",
    "payer_id": "456e7890-e89b-12d3-a456-426614174001",
    "amount_in_minor_units": 25000,
    "currency_code": "USD",
    "rail": "standard_ach",
    "status": "created",
    "status_recorded_at": "2024-03-20T12:00:00Z",
    "payin_metadata": {
      "payment_method": {
        "account_last_four": "1234",
        "routing_number": "021000021"
      },
      "payer": {
        "name": "John Smith",
        "email": "john.smith@example.com"
      }
    },
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "amount_in_cents": 25000,
    "client_metadata": {}
  }
}

Retrieves detailed information about a specific payin by its unique identifier. This endpoint returns the complete payin object including current status and payin metadata.

Path Parameters

Parameter	Type	Required	Description
`payin_id`	UUID	Yes	Unique identifier of the payin to retrieve

Success Responses

Status Code	Description
200	OK - The payin was successfully retrieved

Error Responses

Status Code	Error Code	Description
401	AUTHENTICATION_ERROR	Authentication credentials are invalid or missing
403	AUTHORIZATION_ERROR	You do not have permission to perform this action
404	PAYIN_NOT_FOUND	The specified payin was not found or doesn’t belong to your entity

Retrieves detailed information about a specific payin by its unique identifier. This endpoint returns the complete payin object including current status and payin metadata. **Path Parameters** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payin_id` | UUID | Yes | Unique identifier of the payin to retrieve | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK - The payin was successfully retrieved | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | PAYIN_NOT_FOUND | The specified payin was not found or doesn't belong to your entity |

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

payin_idstringRequiredformat: "uuid"

Response

Payin retrieved successfully

dataobject

Response model for payin operations.

warningstring or null

Errors

404

Not Found Error

$	curl https://api.useroot.com/api/payins/payin_id \
>	-H "x-api-key: <apiKey>"